From 3858599be0fadbb7c4c5f2558f2f2d31a3ef4e25 Mon Sep 17 00:00:00 2001 From: William Cheng Date: Tue, 6 Feb 2024 16:55:37 +0800 Subject: [PATCH] udpate typescript samples --- .../echo_api/typescript-axios/build/README.md | 5 ++- .../typescript-aurelia/default/README.md | 44 ++++++++++++------- .../builds/es6-target/README.md | 5 ++- .../README.md | 5 ++- .../builds/with-npm-version/README.md | 5 ++- .../builds/es6-target/README.md | 5 ++- .../prefix-parameter-interfaces/README.md | 5 ++- .../builds/sagas-and-records/README.md | 5 ++- .../builds/with-npm-version/README.md | 5 ++- .../builds/without-runtime-checks/README.md | 5 ++- .../petstore/typescript-jquery/npm/README.md | 5 ++- .../builds/with-npm-version/README.md | 5 ++- .../builds/es6-target/README.md | 2 +- .../builds/with-npm-version/README.md | 2 +- 14 files changed, 63 insertions(+), 40 deletions(-) diff --git a/samples/client/echo_api/typescript-axios/build/README.md b/samples/client/echo_api/typescript-axios/build/README.md index dee9dba2ad59..72b07db402e4 100644 --- a/samples/client/echo_api/typescript-axios/build/README.md +++ b/samples/client/echo_api/typescript-axios/build/README.md @@ -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 +``` diff --git a/samples/client/petstore/typescript-aurelia/default/README.md b/samples/client/petstore/typescript-aurelia/default/README.md index 1475a466d64a..f6fc6e804adc 100644 --- a/samples/client/petstore/typescript-aurelia/default/README.md +++ b/samples/client/petstore/typescript-aurelia/default/README.md @@ -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')'; ``` diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/README.md b/samples/client/petstore/typescript-axios/builds/es6-target/README.md index 79a1afb768a9..856ac0a1ef56 100644 --- a/samples/client/petstore/typescript-axios/builds/es6-target/README.md +++ b/samples/client/petstore/typescript-axios/builds/es6-target/README.md @@ -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 +``` diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/README.md b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/README.md index 79a1afb768a9..856ac0a1ef56 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/README.md +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/README.md @@ -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 +``` diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/README.md b/samples/client/petstore/typescript-axios/builds/with-npm-version/README.md index 79a1afb768a9..856ac0a1ef56 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version/README.md +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/README.md @@ -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 +``` diff --git a/samples/client/petstore/typescript-fetch/builds/es6-target/README.md b/samples/client/petstore/typescript-fetch/builds/es6-target/README.md index 8c188be0ead2..9b50c27ec63f 100644 --- a/samples/client/petstore/typescript-fetch/builds/es6-target/README.md +++ b/samples/client/petstore/typescript-fetch/builds/es6-target/README.md @@ -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 +``` diff --git a/samples/client/petstore/typescript-fetch/builds/prefix-parameter-interfaces/README.md b/samples/client/petstore/typescript-fetch/builds/prefix-parameter-interfaces/README.md index 8c188be0ead2..9b50c27ec63f 100644 --- a/samples/client/petstore/typescript-fetch/builds/prefix-parameter-interfaces/README.md +++ b/samples/client/petstore/typescript-fetch/builds/prefix-parameter-interfaces/README.md @@ -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 +``` diff --git a/samples/client/petstore/typescript-fetch/builds/sagas-and-records/README.md b/samples/client/petstore/typescript-fetch/builds/sagas-and-records/README.md index 8c188be0ead2..9b50c27ec63f 100644 --- a/samples/client/petstore/typescript-fetch/builds/sagas-and-records/README.md +++ b/samples/client/petstore/typescript-fetch/builds/sagas-and-records/README.md @@ -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 +``` diff --git a/samples/client/petstore/typescript-fetch/builds/with-npm-version/README.md b/samples/client/petstore/typescript-fetch/builds/with-npm-version/README.md index 8c188be0ead2..9b50c27ec63f 100644 --- a/samples/client/petstore/typescript-fetch/builds/with-npm-version/README.md +++ b/samples/client/petstore/typescript-fetch/builds/with-npm-version/README.md @@ -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 +``` diff --git a/samples/client/petstore/typescript-fetch/builds/without-runtime-checks/README.md b/samples/client/petstore/typescript-fetch/builds/without-runtime-checks/README.md index 8c188be0ead2..9b50c27ec63f 100644 --- a/samples/client/petstore/typescript-fetch/builds/without-runtime-checks/README.md +++ b/samples/client/petstore/typescript-fetch/builds/without-runtime-checks/README.md @@ -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 +``` diff --git a/samples/client/petstore/typescript-jquery/npm/README.md b/samples/client/petstore/typescript-jquery/npm/README.md index c5d3edc9b4b6..40b6ab922308 100644 --- a/samples/client/petstore/typescript-jquery/npm/README.md +++ b/samples/client/petstore/typescript-jquery/npm/README.md @@ -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 +``` diff --git a/samples/client/petstore/typescript-redux-query/builds/with-npm-version/README.md b/samples/client/petstore/typescript-redux-query/builds/with-npm-version/README.md index 1e9968966bc1..2413d8ea28f2 100644 --- a/samples/client/petstore/typescript-redux-query/builds/with-npm-version/README.md +++ b/samples/client/petstore/typescript-redux-query/builds/with-npm-version/README.md @@ -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 +``` diff --git a/samples/client/petstore/typescript-rxjs/builds/es6-target/README.md b/samples/client/petstore/typescript-rxjs/builds/es6-target/README.md index 2c35cd552d22..90a286651e88 100644 --- a/samples/client/petstore/typescript-rxjs/builds/es6-target/README.md +++ b/samples/client/petstore/typescript-rxjs/builds/es6-target/README.md @@ -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 diff --git a/samples/client/petstore/typescript-rxjs/builds/with-npm-version/README.md b/samples/client/petstore/typescript-rxjs/builds/with-npm-version/README.md index 2c35cd552d22..90a286651e88 100644 --- a/samples/client/petstore/typescript-rxjs/builds/with-npm-version/README.md +++ b/samples/client/petstore/typescript-rxjs/builds/with-npm-version/README.md @@ -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