bevry / discourser

Discourse API Client written in TypeScript for Node.js and Browser environments

discourser

Discourser is an API Client for the Discourse API written in TypeScript for Node.js and Browser environments.

Its special features are:

• TypeScript Types
• Respecting Rate Limits
• Optional Heavy Caching
• Post Modifiers (can be used for global find and replace across all posts on the forum)

It is currently under heavy construction, however is being used in production, and will eventually stabilise.

The CLI executable is currently only for Bevry use. Eventually the Bevry specific parts of it will be abstracted out. Do not use the CLI currently in your own projects.

Usage

Complete API Documentation.

Install

npm

Install Globally

• Install: npm install --global discourser
• Executable: discourser

Install Locally

• Install: npm install --save discourser
• Executable: npx discourser
• Import: import pkg from ('discourser')
• Require: const pkg = require('discourser').default

Skypack

<script type="module">
    import pkg from '//cdn.skypack.dev/discourser@^2.1.0'
</script>

unpkg

<script type="module">
    import pkg from '//unpkg.com/discourser@^2.1.0'
</script>

jspm

<script type="module">
    import pkg from '//dev.jspm.io/[email protected]'
</script>

Editions

This package is published with the following editions:

• discourser/source/index.ts is TypeScript source code with Import for modules
• discourser/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
• discourser aliases discourser/edition-es2018/index.js
• discourser/edition-es2018/index.js is TypeScript compiled against ES2018 for Node.js with Require for modules
• discourser/edition-es2018-esm/index.js is TypeScript compiled against ES2018 for Node.js with Import for modules

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions
• Lucian Buzzo — view contributions

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

• Copyright © 2020+ Benjamin Lupton

and licensed under:

• Artistic License 2.0