houdini/lib/swagger-typescript-jquery
2018-05-22 13:33:35 -05:00
..
api.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
apis.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
configuration.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
git_push.sh.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
index.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
licenseInfo.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
masterApiEntry.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
model.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
modelEnum.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
modelGeneric.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
models.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
package.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
README.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
tsconfig.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
typings.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00
variables.mustache Support for grape and onboarding via react 2018-05-22 13:33:35 -05:00

## {{npmName}}@{{npmVersion}}

This generator creates TypeScript/JavaScript client that utilizes [jQuery](https://jquery.com/). The generated Node module can be used in the following environments:

Environment
* Node.js
* Webpack
* Browserify

Language level
* ES5 - you must have a Promises/A+ library installed
* ES6

Module system
* CommonJS
* ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))

### Building

To build an compile the typescript sources to javascript use:
```
npm install
npm run build
```

### Publishing

First build the package then run ```npm publish```

### Consuming

navigate to the folder of your consuming project and run one of the following commands.

_published:_

```
npm install {{npmName}}@{{npmVersion}} --save
```

_unPublished (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save