udpate typescript samples

This commit is contained in:
William Cheng
2024-02-06 16:55:37 +08:00
parent 4ec170236d
commit 3858599be0
14 changed files with 63 additions and 40 deletions

View File

@@ -15,7 +15,7 @@ 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))
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building
@@ -27,7 +27,7 @@ npm run build
### Publishing
First build the package then run ```npm publish```
First build the package then run `npm publish`
### Consuming
@@ -43,3 +43,4 @@ _unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```

View File

@@ -1,57 +1,69 @@
# TypeScript-Aurelia
This generator creates TypeScript/JavaScript client that is injectable by [Aurelia](http://aurelia.io/).
The generated Node module can be used in the following environments:
The generated Node module can be used in the following environments:
Environment
* Node.js
* Webpack
* Browserify
- Node.js
- Webpack
- Browserify
Language level
* ES5 - you must have a Promises/A+ library installed
* ES6
- 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))
- CommonJS
- ES6 module system
### Building ####
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building
To build and compile the typescript sources to javascript use:
```
npm install
npm run build
```
#### NPM ####
#### NPM
You may publish the module to NPM. In this case, you would be able to install the module as any other NPM module. It may be useful to use [scoped packages](https://docs.npmjs.com/misc/scope).
You can also use `npm link` to link the module. However, this would not modify `package.json` of the installing project, as such you would need to relink every time you deploy that project.
You can also use `npm link` to link the module. However, this would not modify `package.json` of the installing project, as such you would need to relink every time you deploy that project.
You can also directly install the module using `npm install file_path`. If you do `npm install file_path --save`, NPM will save relative path to `package.json`. In this case, `npm install` and `npm shrinkwrap` may misbehave. You would need to manually edit `package.json` and replace it with absolute path.
You can also directly install the module using `npm install file_path`. If you do `npm install file_path --save`, NPM will save relative path to `package.json`. In this case, `npm install` and `npm shrinkwrap` may misbehave. You would need to manually edit `package.json` and replace it with absolute path.
Regardless of which method you deployed your NPM module, the ES6 module syntaxes are as follows:
Regardless of which method you deployed your NPM module, the ES6 module syntaxes are as follows:
```
import * as localName from 'npmName';
import {operationId} from 'npmName';
```
The CommonJS syntax is as follows:
```
import localName = require('npmName');
```
#### Direct copy/symlink ####
#### Direct copy/symlink
You may also simply copy or symlink the generated module into a directory under your project. The syntax of this is as follows:
With ES6 module syntax, the following syntaxes are supported:
With ES6 module syntax, the following syntaxes are supported:
```
import * as localName from './symlinkDir';
import {operationId} from './symlinkDir';
```
The CommonJS syntax is as follows:
```
import localName = require('./symlinkDir')';
```

View File

@@ -15,7 +15,7 @@ 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))
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building
@@ -27,7 +27,7 @@ npm run build
### Publishing
First build the package then run ```npm publish```
First build the package then run `npm publish`
### Consuming
@@ -43,3 +43,4 @@ _unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```

View File

@@ -15,7 +15,7 @@ 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))
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building
@@ -27,7 +27,7 @@ npm run build
### Publishing
First build the package then run ```npm publish```
First build the package then run `npm publish`
### Consuming
@@ -43,3 +43,4 @@ _unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```

View File

@@ -15,7 +15,7 @@ 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))
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building
@@ -27,7 +27,7 @@ npm run build
### Publishing
First build the package then run ```npm publish```
First build the package then run `npm publish`
### Consuming
@@ -43,3 +43,4 @@ _unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```

View File

@@ -15,7 +15,7 @@ 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))
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building
@@ -27,7 +27,7 @@ npm run build
### Publishing
First build the package then run ```npm publish```
First build the package then run `npm publish`
### Consuming
@@ -43,3 +43,4 @@ _unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```

View File

@@ -15,7 +15,7 @@ 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))
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building
@@ -27,7 +27,7 @@ npm run build
### Publishing
First build the package then run ```npm publish```
First build the package then run `npm publish`
### Consuming
@@ -43,3 +43,4 @@ _unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```

View File

@@ -15,7 +15,7 @@ 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))
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building
@@ -27,7 +27,7 @@ npm run build
### Publishing
First build the package then run ```npm publish```
First build the package then run `npm publish`
### Consuming
@@ -43,3 +43,4 @@ _unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```

View File

@@ -15,7 +15,7 @@ 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))
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building
@@ -27,7 +27,7 @@ npm run build
### Publishing
First build the package then run ```npm publish```
First build the package then run `npm publish`
### Consuming
@@ -43,3 +43,4 @@ _unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```

View File

@@ -15,7 +15,7 @@ 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))
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building
@@ -27,7 +27,7 @@ npm run build
### Publishing
First build the package then run ```npm publish```
First build the package then run `npm publish`
### Consuming
@@ -43,3 +43,4 @@ _unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```

View File

@@ -15,7 +15,7 @@ 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/declaration-files/publishing.html))
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building
@@ -27,7 +27,7 @@ npm run build
### Publishing
First build the package then run ```npm publish```
First build the package then run `npm publish`
### Consuming
@@ -43,3 +43,4 @@ _unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```

View File

@@ -3,7 +3,7 @@
This generator creates TypeScript/JavaScript client that utilizes [redux-query](https://amplitude.github.io/redux-query/).
The generated Node module does not depend on ReactJS specifically.
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))
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building
@@ -15,7 +15,7 @@ npm run build
### Publishing
First build the package then run ```npm publish```
First build the package then run `npm publish`
### Consuming
@@ -31,3 +31,4 @@ _unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
```

View File

@@ -15,7 +15,7 @@ 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))
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building

View File

@@ -15,7 +15,7 @@ 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))
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
### Building