@ovotech/apollo-datasource-soap
v4.1.0
Published
SOAPDataSource is responsible for fetching data using soap
Downloads
160
Maintainers
Keywords
Readme
Apollo SOAPDataSource
SOAPDataSource is responsible for calling a soap client. Integrates with the cache, following the example of Apollo Data Sources.
Using
yarn add @ovotech/apollo-datasource-soap
This module ships with TypeScript types.
import { SOAPDataSource } from '@ovotech/apollo-datasource-soap';
import { createClientAsync } from 'soap';
class MySOAPDataSource extends SOAPDataSource {
async get() {
return await this.callSoapMethod('myFunc', { someArg: 'val' });
}
async getFull() {
return await this.callSoapServiceMethod('myService', 'myPort', 'myFunc', { someArg: 'val' });
}
async rawClientCall() {
const client = await this.getClient();
return await client.myFuncAsync({ something: 'other' });
}
}
const client = await createClientAsync('...some.wsdl'));
const ds = new MySOAPDataSource(client);
// or load client async
const ds = new MySOAPDataSource(() => createClientAsync('...some.wsdl')));
Running the tests
yarn test
Coding style (linting, etc) tests
Style is maintained with prettier and tslint
yarn lint
Deployment
To deploy a new version, push to master and then create a new release. CircleCI will automatically build and deploy a the version to the npm registry.
Contributing
Have a bug? File an issue with a simple example that reproduces this so we can take a look & confirm.
Want to make a change? Submit a PR, explain why it's useful, and make sure you've updated the docs (this file) and the tests (see test/S3DataSource.spec.ts
). You can run the tests with SERVICES=s3 localstack start
and yarn test
.
Responsible Team
- Boost Internal Tools (BIT)
License
This project is licensed under Apache 2 - see the LICENSE file for details