# simple-soap

> Simplified soap client

Latest version **1.0.0** (published 2016-07-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-soap
pnpm add simple-soap
yarn add simple-soap
bun add simple-soap
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-07-06 |
| First published | 2016-07-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=5 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tom Vincent |
| Maintainers | tlvince |
| Keywords | soap |

## Links

- npm: https://www.npmjs.com/package/simple-soap
- Repository: https://github.com/tlvince/simple-soap
- Homepage: https://github.com/tlvince/simple-soap#readme
- Issues: https://github.com/tlvince/simple-soap/issues
- npm.io page: https://npm.io/package/simple-soap

## Dependencies (2)

- [pify](https://npm.io/package/pify.md) ^2.3.0
- [soap](https://npm.io/package/soap.md) ^0.16.0

## Recent versions

- 1.0.0 (latest) — 2016-07-06

## README

# simple-soap

[![Build Status][travis-image]][travis-url]
[![npm version][npm-image]][npm-url]
[![License][license-image]][license-url]

[travis-url]: https://travis-ci.org/tlvince/simple-soap
[travis-image]: https://img.shields.io/travis/tlvince/simple-soap.svg
[npm-url]: https://www.npmjs.com/package/simple-soap
[npm-image]: https://img.shields.io/npm/v/simple-soap.svg
[license-url]: https://opensource.org/licenses/MIT
[license-image]: https://img.shields.io/npm/l/simple-soap.svg

> Simplified soap client

```js
const simpleSoap = require('simple-soap')
const config = {
  url: 'https://example.com/soap/server',
  username: 'test',
  password: 'test',
  method: 'Method'
}
simpleSoap(config)
  .then(res => console.log(res))
  .catch(err => console.error(err))
```

Wrapper over the [node-soap][] client using a promise interface.

[node-soap]: https://github.com/vpulim/node-soap

## Installation

```shell
npm install --save simple-soap
```

## Usage

### `simpleSoap(config[, params])`

#### `config`

Configuration object. Required properties:

* `url`: SOAP endpoint
* `username`: Basic auth username
* `password`: Basic auth password
* `method`: SOAP action/method

Optional properties:

* `request`: [request][] options

[request]: https://github.com/request/request#requestoptions-callback

#### `params`

Optional object of params to passed to the method call.

## Author

© 2016 Tom Vincent <git@tlvince.com> (https://tlvince.com)

## License

Released under the [MIT license](http://tlvince.mit-license.org).

---
_Source: https://npm.io/package/simple-soap · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._