@codeboard/api

We have made a first-party api wrapper for Node.JS Projects that interact with the api with ease of use.

If you have questions, feel free to contact us.

Installation

Why @codeboard/api ?

• First-party API Wrapper (Made by the same dev as CodeBoard)
• Much Efficient
• Easier approach
• Type safe
• Better Intellisense
• Lighter. No compromise on performance

All methods from the class returns a Promise so you should await it and should be located inside an async function. Or your project should be configured to top-level await

Codeboard class

Access the future of code sharing platform with this first-party wrapper

Required: API_KEY
The API Key used to access the privileged endpoints like save and fetch. Get your key here

Types

CodeBoard.ping()

Get the ping latency of the api.

This returns a Promise so you should await it and should be located inside an async function. Or your project should be configured to top-level await

Types

CodeBoard.teapot()

Im a teapot
A very old developers april joke. We won't let it fade away

This returns a Promise so you should await it and should be located inside an async function. Or your project should be configured to top-level await

Types

CodeBoard.save()

Save a board to the CodeBoard

• Requires: API Key

• Ratelimits: 20 per minute

This returns a Promise so you should await it and should be located inside an async function. Or your project should be configured to top-level await

Types

• SaveBody

• SaveResponse

CodeBoard.fetch()

Fetch a board from the CodeBoard with a board id

• Required: API Key

• Ratelimits: 40 per minute

This returns a Promise so you should await it and should be located inside an async function. Or your project should be configured to top-level await

Types

• FetchBody

• BoardFile

Support

Let's build a better community, together.