https://github.com/maaassistantarknights/maa-copilot-client-ts

MAA 作业站 API - TypeScript 客户端
https://github.com/maaassistantarknights/maa-copilot-client-ts

Last synced: about 2 months ago
JSON representation

MAA 作业站 API - TypeScript 客户端

• Host: GitHub
• URL: https://github.com/maaassistantarknights/maa-copilot-client-ts
• Owner: MaaAssistantArknights
• License: agpl-3.0
• Created: 2024-03-01T03:57:41.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-10-28T15:41:39.000Z (about 2 months ago)
• Last Synced: 2024-10-28T16:58:49.375Z (about 2 months ago)
• Language: TypeScript
• Size: 87.9 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## [email protected]

This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). 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 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

```

### 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 [email protected] --save

```

_unPublished (not recommended):_

```

npm install PATH_TO_GENERATED_PACKAGE --save

```