# wsdl-to-ts

> Build TypeScript typings for SOAP WSDL

Latest version **0.2.3** (published 2018-07-31) · ISC license · 0 weekly downloads

## Install

```sh
npm install wsdl-to-ts
pnpm add wsdl-to-ts
yarn add wsdl-to-ts
bun add wsdl-to-ts
```

Provides the command `wsdl-to-ts`.

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.3 |
| Published | 2018-07-31 |
| First published | 2017-06-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 106.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 63 |
| Author | TimLuq |
| Maintainers | timluq |
| Keywords | soap, typescript, wsdl, ts |

## Links

- npm: https://www.npmjs.com/package/wsdl-to-ts
- Repository: https://github.com/TimLuq/wsdl-to-ts
- Homepage: https://github.com/TimLuq/wsdl-to-ts#readme
- Issues: https://github.com/TimLuq/wsdl-to-ts/issues
- npm.io page: https://npm.io/package/wsdl-to-ts

## Dependencies (3)

- [soap](https://npm.io/package/soap.md) >=0.21.0 <1.0.0
- [mkdirp](https://npm.io/package/mkdirp.md) >=0.5.1 <1.0.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.0

## Alternatives

- [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads
- [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads
- [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads
- [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads

## Recent versions

- 0.2.3 (latest) — 2018-07-31
- 0.2.2 — 2018-07-31
- 0.2.1 — 2018-07-26
- 0.2.0 — 2018-07-26
- 0.1.3 — 2017-07-27
- 0.1.2 — 2017-06-15
- 0.1.1 — 2017-06-12
- 0.1.0 — 2017-06-12

## README

# wsdl-to-ts

<a href="https://travis-ci.org/TimLuq/wsdl-to-ts">
    <img src="https://travis-ci.org/TimLuq/wsdl-to-ts.svg?branch=master"
         alt="build status" />
</a>
<a href="https://www.npmjs.com/package/wsdl-to-ts">
    <img src="https://img.shields.io/npm/v/wsdl-to-ts.svg"
         alt="npm version" />
</a>
<a href="https://github.com/TimLuq/wsdl-to-ts/blob/master/LICENSE">
    <img src="https://img.shields.io/npm/l/wsdl-to-ts.svg"
         alt="license" />
</a>
<a href="https://david-dm.org/TimLuq/wsdl-to-ts">
    <img src="https://david-dm.org/TimLuq/wsdl-to-ts/status.svg"
         alt="dependency status" />
</a>

A CLI tool and library for nodejs to generate TypeScript typings from a WSDL service.

## Installation
Installation is done either through [npm](https://npmjs.com) or [yarn](https://yarnpkg.com).

### Installation for Command Line usage

To install CLI tool globally run one of the following command as root or sudo:
```sh
$ npm install -g wsdl-to-ts
$ yarn global add wsdl-to-ts
```

To install CLI tool for the current user one of these commands may be used (which places working directory at users `$HOME`):
```sh
$ cd && npm install wsdl-to-ts
$ cd && yarn add wsdl-to-ts
```

### Installation for Library usage

To install a library as a dependency to your current npm project you enter your project directory as the current directory and run one of the following commands:
```sh
$ npm install --save wsdl-to-ts
$ yarn add wsdl-to-ts
```

## Usage

If any more documentation is needed for library usage, other than the IDE completions; feel free to open an [issue](https://github.com/TimLuq/wsdl-to-ts/issues). Also take a look at the [type definitions](https://github.com/TimLuq/wsdl-to-ts/blob/master/esm/wsdl-to-ts.d.ts)

### Usage for Command Line

Check version:
```sh
$ wsdl-to-ts --version
```

Generate typings for a WSDL located on an URI at the default output directory (multiple may be done at the same time by listing more on the command line):
```sh
$ cd /tmp
$ wsdl-to-ts "https://www.w3schools.com/xml/tempconvert.asmx?WSDL"
$ ls wsdl/**/*
wsdl/TempConvert/TempConvertSoap12.ts  wsdl/TempConvert/TempConvertSoap.ts
```

The output directory may be changed to any directory using the `--outdir` flag.
```sh
$ wsdl-to-ts --outdir="./some/other/dir" "https://www.w3schools.com/xml/tempconvert.asmx?WSDL"
```

#### CLI flags
* `--version` - Display which version you are currently executing.
* `--outdir=SOME/DIR/PATH` - Sets the path which will contain the type definitions.
* `--tslint=RULE0,RULE1,RULE2` - Enable specified rules in all generated files.
* `--tslint=false` - Disables tslint in all generated files.
* `--tslint-disable=RULE0,RULE1,RULE2` - Disable specified rules in all generated files.

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