@softvision/webpdf-wsclient-typescript
Version:
A simplified and optimized API client library for the webPDF server
38 lines (26 loc) • 2.36 kB
Markdown
# webPDF wsclient TypeScript
This repository contains a simplified and optimized client library for the webPDF server, and serves as an alternative to more complex REST APIs.
The library implements the required stubs and session management in ready-to-use interface classes and provides a common object based parameterization for webservice calls.
[webPDF](https://www.webpdf.de/) is a commercial multi-platform server solution for creating and processing PDF documents. To use the webPDF wsclient library for webservice calls, a running webPDF installation is required. A demo version as Windows installation, Linux package or as a virtual machine can be downloaded from the [product page](https://docs.webpdf.de/docs/download/).
> **Note**: Unless otherwise marked, the following is based on webPDF version 10 or newer. If you are using an older version please update to use all parameters for the current release of the library. You will always find the newest version at the product [download page](https://docs.webpdf.de/docs/download/).
## Download
> **Note:** Starting with wsclient 9.x the wsclient´s and webPDF server´s version numbers have been synchronized, to simplify finding the proper wsclient for your webPDF server.
You can use this library by adding this dependency to your project:
```
yarn add @softvision/webpdf-wsclient-typescript
```
```
npm install @softvision/webpdf-wsclient-typescript
```
## Usage
You will find some [usage examples](https://github.com/softvision-dev/webpdf-wsclient-typescript/wiki/Usage) in the wiki.
## Documentation
Have a look at our [wiki](https://github.com/softvision-dev/webpdf-wsclient-typescript/wiki) for examples and details.
## Development and support
If you have any questions on how to use webPDF, or this library, or have ideas for future development, please get in touch via our [product homepage](https://www.webpdf.de).
If you find any issues, please file a [bug](https://github.com/softvision-dev/webpdf-wsclient-typescript/issues) after checking for duplicates or create a [pull request](https://github.com/softvision-dev/webpdf-wsclient-typescript/pulls).
## More help
Learn even more about our product in our [webPDF Documentation](https://www.webpdf.de/en/documentation).
## License
Please, see the [license](LICENSE) file for more information.