Screenshot / Code Snippet
About
Stack Exchange API types is a type declaration package adding type definitions for objects exposed by Stack Exchange API for both client- and server-side consumption.
The package is automatically generated, so all currently available types should be present in the definitions - do let us know if we missed anything!
License
The package is licensed under the GPL-3.0-or-later license.
Download
The package is published as both an NPM package and a GitHub package. Can be installed via a package manager like NPM as usual:
npm install --save-dev @userscripters/stackexchange-api-types
If you opt to install it from the GitHub registry, please note that it only supports scoped packages, you will need a simple .npmrc file at your project root:
@userscripters:registry=https://npm.pkg.github.com
You will also need to be logged in to GitHub. An easy way to do so is to have a global .npmrc with your PAT (personal access token) set as an access token:
//npm.pkg.github.com/:_authToken=<your token here>
Platform
The type declarations are intended to be used with TypeScript/JavaScript projects targeting either browsers or server-side environments like Node.js.
Changelog
| Version | Changes |
|---|---|
| 0.3.0 | Deduplicated generated interfaces & exported types globally as StackExchangeAPI namespace |
Contact
Author: Oleg Valter
Organization: UserScripters
Please, submit bug reports on the source repository.
Before adding a new one, please check if it hasn't been raised before.
You can also drop by to chat, we are a friendly bunch.
Code
Source code is written TypeScript (d.ts declaration files and type generator in proper TypeScript).
The project is using tsd (see repo) for unit-testing types.
Contributions are welcome, you can always submit a PR here.