README
¶
DocuStream Go Client
The DocuStream Go Client provides an interface for interacting with the DocuStream service, allowing you to apply word formats from templates and convert Word files to PDF.
Features
1. Apply Word Formats from a Template: ApplyWord
- Description: Applies specific word formats to documents using a pre-defined template.
- Prerequisites: The DocuStream service must be running. Refer to the DocuStream repository for setup instructions.
- Client Setup: Use
NewWordClientto create a client that connects to the DocuStream service.
2. Convert Word Files to PDF: WordToPDF
- Description: Converts Word documents to PDF format.
- Prerequisites: Ensure the DocuStream service for conversion is running. See the service setup instructions for details.
- Client Setup: Use
NewConvertClientto create a client for handling conversion tasks.
Usage
- For detailed usage, refer to the test cases provided in the repository, which demonstrate the use of
ApplyWordandWordToPDFfunctions.
Additional Information
- Dependencies: Ensure all dependencies are installed and services are correctly configured.
- Setup: Refer to the DocuStream repository README for complete setup instructions.
Support
- For issues or questions, open an issue on the GitHub repository.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConnectOptions ¶
type ConnectOptions struct {
Url string
}
type Convert ¶ added in v0.0.6
type Convert struct {
// contains filtered or unexported fields
}
func NewConvertClient ¶ added in v0.0.6
func NewConvertClient(c *ConnectOptions) (*Convert, error)
type DocuValue ¶ added in v0.0.5
type DocuValue struct {
Type DocuValueType
Key string
Value DocuValueRaw
}
type DocuValueRaw ¶ added in v0.0.5
type DocuValueRaw = interface{}
type DocuValueType ¶ added in v0.0.5
type DocuValueType pb.DocuValueType
const DocuValueTypeImage DocuValueType = 1
const DocuValueTypeText DocuValueType = 0
type Word ¶
type Word struct {
// contains filtered or unexported fields
}
func NewWordClient ¶
func NewWordClient(c *ConnectOptions) (*Word, error)
func (*Word) Apply ¶
func (w *Word) Apply(req *WordApplyReq) (*WordApplyRes, error)
type WordApplyReq ¶
type WordApplyRes ¶
type WordApplyRes struct {
Docu []byte
}
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.