https://github.com/timluq/wsdl-to-ts
Generate TypeScript typings for WSDL services
https://github.com/timluq/wsdl-to-ts
soap typescript wsdl
Last synced: 9 months ago
JSON representation
Generate TypeScript typings for WSDL services
- Host: GitHub
- URL: https://github.com/timluq/wsdl-to-ts
- Owner: TimLuq
- License: isc
- Created: 2017-06-12T08:34:29.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-10-07T08:27:46.000Z (over 3 years ago)
- Last Synced: 2025-05-01T10:23:22.618Z (about 1 year ago)
- Topics: soap, typescript, wsdl
- Language: TypeScript
- Size: 96.7 KB
- Stars: 62
- Watchers: 6
- Forks: 48
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wsdl-to-ts
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.