Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/radekxrandom/soap-client
Minimalistic soap messaging protocol client for node.js
https://github.com/radekxrandom/soap-client
libraries node nodejs soap soap-client soap-message wsdl-document
Last synced: 5 days ago
JSON representation
Minimalistic soap messaging protocol client for node.js
- Host: GitHub
- URL: https://github.com/radekxrandom/soap-client
- Owner: radekxrandom
- License: unlicense
- Created: 2020-10-14T19:33:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-27T01:43:31.000Z (over 3 years ago)
- Last Synced: 2025-02-01T20:35:16.762Z (13 days ago)
- Topics: libraries, node, nodejs, soap, soap-client, soap-message, wsdl-document
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@radekborandom/soap-client
- Size: 169 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# soap-client
#### A minimalistic soap messaging protocol client created for node.js
- [Install](#install)
- [Client initialization](#client-initialization)
- [Sending a soap message](#sending-a-soap-message)
- [Security](#security)
# Install
- #### Install with [yarn](https://classic.yarnpkg.com/en/package/@radekborandom/soap-client)
```sh
$ yarn add @radekborandom/soap-client
```
- #### Install with [npm](https://www.npmjs.com/package/@radekborandom/soap-client)
```sh
$ npm i @radekborandom/soap-client
```
### Client initialization
##### await soapClient.generateClient(wsdlUrl) - Generate a new soap client for the web service specified in the wsdl document.
Parse provided WSDL document. Generate methods from the operations defined in it.
```javascript
const soapClient = require("soap-client");
// your app code
const client = await soapClient.generateClient(
"http://example.com/wsdl/service.wsdl"
);
```
### Sending a soap message
##### await client.operationName({...args}) - Perform one of the operations defined in the WSDL
Call a particular method to perform operation defined in the WSDL document. Name of the method is the same as the name of operation to be performed. Response is parsed and returned either as a primitive value (if soap response body has only one field) or as a object.
```javascript
const soapClient = require("soap-client");
// your app code
const client = await soapClient.generateClient(
"http://example.com/wsdl/service.wsdl"
);
const response = await client.methodName({ ...args });
```
### Security
Currently only the UsernameToken method of authentication is supported.
##### client.addUsernameToken(username, password) - Adds the UsernameToken to client instance
Generate header with UsernameToken to be appended to each request/operation performed by this instance.
```javascript
const soapClient = require("soap-client");
// your app code
const client = await soapClient.generateClient(
"http://example.com/wsdl/service.wsdl"
);
client.addUsernameToken("your_username", "your_password");
```