{"id":24382949,"url":"https://github.com/bevry/discourser","last_synced_at":"2025-04-11T01:11:31.133Z","repository":{"id":39258434,"uuid":"256699143","full_name":"bevry/discourser","owner":"bevry","description":"Discourse API Client written in TypeScript for Node.js and Browser environments","archived":false,"fork":false,"pushed_at":"2024-08-06T01:54:33.000Z","size":285,"stargazers_count":6,"open_issues_count":1,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-30T00:55:53.991Z","etag":null,"topics":["discourse","discourse-api","typescript","typescript-definitions"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bevry.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["balupton"],"patreon":"bevry","open_collective":"bevry","ko_fi":"balupton","liberapay":"bevry","tidelift":"npm/discourser","custom":["https://bevry.me/fund"]}},"created_at":"2020-04-18T07:58:43.000Z","updated_at":"2024-06-18T19:01:32.000Z","dependencies_parsed_at":"2024-01-12T07:56:28.538Z","dependency_job_id":"7b466f3e-fc8b-4ba3-98be-9bfc3d313511","html_url":"https://github.com/bevry/discourser","commit_stats":{"total_commits":25,"total_committers":4,"mean_commits":6.25,"dds":0.28,"last_synced_commit":"9aad82e416994f1f8ee11a610d3b8d25a25c6a54"},"previous_names":["bevry/discourse-bevry"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bevry%2Fdiscourser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bevry%2Fdiscourser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bevry%2Fdiscourser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bevry%2Fdiscourser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bevry","download_url":"https://codeload.github.com/bevry/discourser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247601446,"owners_count":20964866,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["discourse","discourse-api","typescript","typescript-definitions"],"created_at":"2025-01-19T10:11:06.865Z","updated_at":"2025-04-11T01:11:31.111Z","avatar_url":"https://github.com/bevry.png","language":"TypeScript","funding_links":["https://github.com/sponsors/balupton","https://patreon.com/bevry","https://opencollective.com/bevry","https://ko-fi.com/balupton","https://liberapay.com/bevry","https://tidelift.com/funding/github/npm/discourser","https://bevry.me/fund","https://thanks.dev/u/gh/bevry","https://buymeacoffee.com/balupton"],"categories":[],"sub_categories":[],"readme":"\u003c!-- TITLE/ --\u003e\n\n\u003ch1\u003ediscourser\u003c/h1\u003e\n\n\u003c!-- /TITLE --\u003e\n\n\n\u003c!-- BADGES/ --\u003e\n\n\u003cspan class=\"badge-githubworkflow\"\u003e\u003ca href=\"https://github.com/bevry/discourser/actions?query=workflow%3Abevry\" title=\"View the status of this project's GitHub Workflow: bevry\"\u003e\u003cimg src=\"https://github.com/bevry/discourser/workflows/bevry/badge.svg\" alt=\"Status of the GitHub Workflow: bevry\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-npmversion\"\u003e\u003ca href=\"https://npmjs.org/package/discourser\" title=\"View this project on NPM\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/discourser.svg\" alt=\"NPM version\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-npmdownloads\"\u003e\u003ca href=\"https://npmjs.org/package/discourser\" title=\"View this project on NPM\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/discourser.svg\" alt=\"NPM downloads\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cbr class=\"badge-separator\" /\u003e\n\u003cspan class=\"badge-githubsponsors\"\u003e\u003ca href=\"https://github.com/sponsors/balupton\" title=\"Donate to this project using GitHub Sponsors\"\u003e\u003cimg src=\"https://img.shields.io/badge/github-donate-yellow.svg\" alt=\"GitHub Sponsors donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-thanksdev\"\u003e\u003ca href=\"https://thanks.dev/u/gh/bevry\" title=\"Donate to this project using ThanksDev\"\u003e\u003cimg src=\"https://img.shields.io/badge/thanksdev-donate-yellow.svg\" alt=\"ThanksDev donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-patreon\"\u003e\u003ca href=\"https://patreon.com/bevry\" title=\"Donate to this project using Patreon\"\u003e\u003cimg src=\"https://img.shields.io/badge/patreon-donate-yellow.svg\" alt=\"Patreon donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-liberapay\"\u003e\u003ca href=\"https://liberapay.com/bevry\" title=\"Donate to this project using Liberapay\"\u003e\u003cimg src=\"https://img.shields.io/badge/liberapay-donate-yellow.svg\" alt=\"Liberapay donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-buymeacoffee\"\u003e\u003ca href=\"https://buymeacoffee.com/balupton\" title=\"Donate to this project using Buy Me A Coffee\"\u003e\u003cimg src=\"https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg\" alt=\"Buy Me A Coffee donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-opencollective\"\u003e\u003ca href=\"https://opencollective.com/bevry\" title=\"Donate to this project using Open Collective\"\u003e\u003cimg src=\"https://img.shields.io/badge/open%20collective-donate-yellow.svg\" alt=\"Open Collective donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-crypto\"\u003e\u003ca href=\"https://bevry.me/crypto\" title=\"Donate to this project using Cryptocurrency\"\u003e\u003cimg src=\"https://img.shields.io/badge/crypto-donate-yellow.svg\" alt=\"crypto donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-paypal\"\u003e\u003ca href=\"https://bevry.me/paypal\" title=\"Donate to this project using Paypal\"\u003e\u003cimg src=\"https://img.shields.io/badge/paypal-donate-yellow.svg\" alt=\"PayPal donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cbr class=\"badge-separator\" /\u003e\n\u003cspan class=\"badge-discord\"\u003e\u003ca href=\"https://discord.gg/nQuXddV7VP\" title=\"Join this project's community on Discord\"\u003e\u003cimg src=\"https://img.shields.io/discord/1147436445783560193?logo=discord\u0026amp;label=discord\" alt=\"Discord server badge\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-twitch\"\u003e\u003ca href=\"https://www.twitch.tv/balupton\" title=\"Join this project's community on Twitch\"\u003e\u003cimg src=\"https://img.shields.io/twitch/status/balupton?logo=twitch\" alt=\"Twitch community badge\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\n\u003c!-- /BADGES --\u003e\n\n\nDiscourser is an API Client for the [Discourse API](https://docs.discourse.org) written in TypeScript for Node.js and Browser environments.\n\nIts special features are:\n\n-   TypeScript Types\n-   Respecting Rate Limits\n-   Optional Heavy Caching\n-   Post Modifiers (can be used for global find and replace across all posts on the forum)\n\nIt is currently under heavy construction, however is being used in production, and will eventually stabilise.\n\nThe 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.\n\n## Usage\n\n[Complete API Documentation.](http://master.discourser.bevry.surge.sh/docs/)\n\n\u003c!-- INSTALL/ --\u003e\n\n\u003ch2\u003eInstall\u003c/h2\u003e\n\n\u003ca href=\"https://npmjs.com\" title=\"npm is a package manager for javascript\"\u003e\u003ch3\u003enpm\u003c/h3\u003e\u003c/a\u003e\n\u003ch4\u003eInstall Globally\u003c/h4\u003e\n\u003cul\u003e\n\u003cli\u003eInstall: \u003ccode\u003enpm install --global discourser\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eExecutable: \u003ccode\u003ediscourser\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch4\u003eInstall Locally\u003c/h4\u003e\n\u003cul\u003e\n\u003cli\u003eInstall: \u003ccode\u003enpm install --save discourser\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eExecutable: \u003ccode\u003enpx discourser\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eImport: \u003ccode\u003eimport pkg from ('discourser')\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eRequire: \u003ccode\u003econst pkg = require('discourser').default\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003ca href=\"https://www.skypack.dev\" title=\"Skypack is a JavaScript Delivery Network for modern web apps\"\u003e\u003ch3\u003eSkypack\u003c/h3\u003e\u003c/a\u003e\n\n``` html\n\u003cscript type=\"module\"\u003e\n    import pkg from '//cdn.skypack.dev/discourser@^2.1.0'\n\u003c/script\u003e\n```\n\n\u003ca href=\"https://unpkg.com\" title=\"unpkg is a fast, global content delivery network for everything on npm\"\u003e\u003ch3\u003eunpkg\u003c/h3\u003e\u003c/a\u003e\n\n``` html\n\u003cscript type=\"module\"\u003e\n    import pkg from '//unpkg.com/discourser@^2.1.0'\n\u003c/script\u003e\n```\n\n\u003ca href=\"https://jspm.io\" title=\"Native ES Modules CDN\"\u003e\u003ch3\u003ejspm\u003c/h3\u003e\u003c/a\u003e\n\n``` html\n\u003cscript type=\"module\"\u003e\n    import pkg from '//dev.jspm.io/discourser@2.1.0'\n\u003c/script\u003e\n```\n\n\u003ch3\u003e\u003ca href=\"https://editions.bevry.me\" title=\"Editions are the best way to produce and consume packages you care about.\"\u003eEditions\u003c/a\u003e\u003c/h3\u003e\n\n\u003cp\u003eThis package is published with the following editions:\u003c/p\u003e\n\n\u003cul\u003e\u003cli\u003e\u003ccode\u003ediscourser/source/index.ts\u003c/code\u003e is \u003ca href=\"https://www.typescriptlang.org/\" title=\"TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. \"\u003eTypeScript\u003c/a\u003e source code with \u003ca href=\"https://babeljs.io/docs/learn-es2015/#modules\" title=\"ECMAScript Modules\"\u003eImport\u003c/a\u003e for modules\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003ediscourser/edition-browsers/index.js\u003c/code\u003e is \u003ca href=\"https://www.typescriptlang.org/\" title=\"TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. \"\u003eTypeScript\u003c/a\u003e compiled against ES2022 for web browsers with \u003ca href=\"https://babeljs.io/docs/learn-es2015/#modules\" title=\"ECMAScript Modules\"\u003eImport\u003c/a\u003e for modules\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003ediscourser\u003c/code\u003e aliases \u003ccode\u003ediscourser/edition-es2018/index.js\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003ediscourser/edition-es2018/index.js\u003c/code\u003e is \u003ca href=\"https://www.typescriptlang.org/\" title=\"TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. \"\u003eTypeScript\u003c/a\u003e compiled against \u003ca href=\"https://en.wikipedia.org/wiki/ECMAScript#9th_Edition_-_ECMAScript_2018\" title=\"ECMAScript ES2018\"\u003eES2018\u003c/a\u003e for \u003ca href=\"https://nodejs.org\" title=\"Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine\"\u003eNode.js\u003c/a\u003e with \u003ca href=\"https://nodejs.org/dist/latest-v5.x/docs/api/modules.html\" title=\"Node/CJS Modules\"\u003eRequire\u003c/a\u003e for modules\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003ediscourser/edition-es2018-esm/index.js\u003c/code\u003e is \u003ca href=\"https://www.typescriptlang.org/\" title=\"TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. \"\u003eTypeScript\u003c/a\u003e compiled against \u003ca href=\"https://en.wikipedia.org/wiki/ECMAScript#9th_Edition_-_ECMAScript_2018\" title=\"ECMAScript ES2018\"\u003eES2018\u003c/a\u003e for \u003ca href=\"https://nodejs.org\" title=\"Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine\"\u003eNode.js\u003c/a\u003e with \u003ca href=\"https://babeljs.io/docs/learn-es2015/#modules\" title=\"ECMAScript Modules\"\u003eImport\u003c/a\u003e for modules\u003c/li\u003e\u003c/ul\u003e\n\n\u003c!-- /INSTALL --\u003e\n\n\n\u003c!-- HISTORY/ --\u003e\n\n\u003ch2\u003eHistory\u003c/h2\u003e\n\n\u003ca href=\"https://github.com/bevry/discourser/blob/master/HISTORY.md#files\"\u003eDiscover the release history by heading on over to the \u003ccode\u003eHISTORY.md\u003c/code\u003e file.\u003c/a\u003e\n\n\u003c!-- /HISTORY --\u003e\n\n\n\u003c!-- CONTRIBUTE/ --\u003e\n\n\u003ch2\u003eContribute\u003c/h2\u003e\n\n\u003ca href=\"https://github.com/bevry/discourser/blob/master/CONTRIBUTING.md#files\"\u003eDiscover how you can contribute by heading on over to the \u003ccode\u003eCONTRIBUTING.md\u003c/code\u003e file.\u003c/a\u003e\n\n\u003c!-- /CONTRIBUTE --\u003e\n\n\n\u003c!-- BACKERS/ --\u003e\n\n\u003ch2\u003eBackers\u003c/h2\u003e\n\n\u003ch3\u003eMaintainers\u003c/h3\u003e\n\nThese amazing people are maintaining this project:\n\n\u003cul\u003e\u003cli\u003e\u003ca href=\"https://balupton.com\"\u003eBenjamin Lupton\u003c/a\u003e — \u003ca href=\"https://github.com/bevry/discourser/commits?author=balupton\" title=\"View the GitHub contributions of Benjamin Lupton on repository bevry/discourser\"\u003eview contributions\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\n\n\u003ch3\u003eSponsors\u003c/h3\u003e\n\nNo sponsors yet! Will you be the first?\n\n\u003cspan class=\"badge-githubsponsors\"\u003e\u003ca href=\"https://github.com/sponsors/balupton\" title=\"Donate to this project using GitHub Sponsors\"\u003e\u003cimg src=\"https://img.shields.io/badge/github-donate-yellow.svg\" alt=\"GitHub Sponsors donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-thanksdev\"\u003e\u003ca href=\"https://thanks.dev/u/gh/bevry\" title=\"Donate to this project using ThanksDev\"\u003e\u003cimg src=\"https://img.shields.io/badge/thanksdev-donate-yellow.svg\" alt=\"ThanksDev donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-patreon\"\u003e\u003ca href=\"https://patreon.com/bevry\" title=\"Donate to this project using Patreon\"\u003e\u003cimg src=\"https://img.shields.io/badge/patreon-donate-yellow.svg\" alt=\"Patreon donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-liberapay\"\u003e\u003ca href=\"https://liberapay.com/bevry\" title=\"Donate to this project using Liberapay\"\u003e\u003cimg src=\"https://img.shields.io/badge/liberapay-donate-yellow.svg\" alt=\"Liberapay donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-buymeacoffee\"\u003e\u003ca href=\"https://buymeacoffee.com/balupton\" title=\"Donate to this project using Buy Me A Coffee\"\u003e\u003cimg src=\"https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg\" alt=\"Buy Me A Coffee donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-opencollective\"\u003e\u003ca href=\"https://opencollective.com/bevry\" title=\"Donate to this project using Open Collective\"\u003e\u003cimg src=\"https://img.shields.io/badge/open%20collective-donate-yellow.svg\" alt=\"Open Collective donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-crypto\"\u003e\u003ca href=\"https://bevry.me/crypto\" title=\"Donate to this project using Cryptocurrency\"\u003e\u003cimg src=\"https://img.shields.io/badge/crypto-donate-yellow.svg\" alt=\"crypto donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\u003cspan class=\"badge-paypal\"\u003e\u003ca href=\"https://bevry.me/paypal\" title=\"Donate to this project using Paypal\"\u003e\u003cimg src=\"https://img.shields.io/badge/paypal-donate-yellow.svg\" alt=\"PayPal donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\n\u003ch3\u003eContributors\u003c/h3\u003e\n\nThese amazing people have contributed code to this project:\n\n\u003cul\u003e\u003cli\u003e\u003ca href=\"https://balupton.com\"\u003eBenjamin Lupton\u003c/a\u003e — \u003ca href=\"https://github.com/bevry/discourser/commits?author=balupton\" title=\"View the GitHub contributions of Benjamin Lupton on repository bevry/discourser\"\u003eview contributions\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"https://github.com/LucianBuzzo\"\u003eLucian Buzzo\u003c/a\u003e — \u003ca href=\"https://github.com/bevry/discourser/commits?author=LucianBuzzo\" title=\"View the GitHub contributions of Lucian Buzzo on repository bevry/discourser\"\u003eview contributions\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\n\n\u003ca href=\"https://github.com/bevry/discourser/blob/master/CONTRIBUTING.md#files\"\u003eDiscover how you can contribute by heading on over to the \u003ccode\u003eCONTRIBUTING.md\u003c/code\u003e file.\u003c/a\u003e\n\n\u003c!-- /BACKERS --\u003e\n\n\n\u003c!-- LICENSE/ --\u003e\n\n\u003ch2\u003eLicense\u003c/h2\u003e\n\nUnless stated otherwise all works are:\n\n\u003cul\u003e\u003cli\u003eCopyright \u0026copy; 2020+ \u003ca href=\"https://balupton.com\"\u003eBenjamin Lupton\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\n\nand licensed under:\n\n\u003cul\u003e\u003cli\u003e\u003ca href=\"http://spdx.org/licenses/Artistic-2.0.html\"\u003eArtistic License 2.0\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\n\n\u003c!-- /LICENSE --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbevry%2Fdiscourser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbevry%2Fdiscourser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbevry%2Fdiscourser/lists"}