
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
@amazebot/rocket-rest
Advanced tools
Simple handlers for calling Rocket.Chat REST API endpoints.
Simple helpers for calling Rocket.Chat REST API endpoints.
See the main Rocket Control README for general configuration.
See Rocket.Chat's REST API docs for specific endpoint requirements.
Install the package.
yarn add @amazebot/rocket-rest
Import the API helpers.
Typescript / Babel:
import * as API from '@amazebot/rocket-rest'
Javascript
const API = require('@amazebot/rocket-rest')
.client([host])
Defines the URL for subsequent API requests. Returns an Axios client.
API requests can be sent without an explicit connection, using the environment defaults from environment configs. It is called implicitly by all requests, so it only needs to be called explicitly to set a new host, or one that's different from the env defaults.
const local = await API.get('channels.list') // env url (default localhost)
API.client('https://my.live.server') // changes target of following requests
const live = await API.get('channels.list') // will request from my.live.server
.login([credentials])
and .logout()
Login is required before making requests to any endpoints that need authorisation. Refer to the Rest API docs, but most do.
Credentials object can be undefined or: { username: string, password: string }
Login without credentials will use defaults from environment configs.
API.login({ username: 'admin', password: 'pass' })
.loggedIn
Property contains a boolean of the login status.
.request(method, endpoint[, data, auth, ignore])
Make a request to your Rocket.Chat instance API.
Endpoint appended to the client URL, with /api/v1
included.
Method can be 'POST' | 'GET' | 'PUT' | 'DELETE'
Data can be an object to post or convert to query params for get requests.
Auth is a boolean to set if the endpoint requires auth (default true).
Ignore optional RegExp for expected error messages to prevent throwing.
// basic server info does not require auth
await API.request('GET', 'info', {}, false)
// get auth and request user list with query params
await API.login()
const users = await API.request('GET', 'users.list', {
fields: { 'username': 1 },
query: { type: { $in: ['user'] } }
})
.get(endpoint[, data, auth, ignore])
Proxy for .request('GET', ...arguments)
.post(endpoint[, data, auth, ignore])
Proxy for .request('POST', ...arguments)
.put(endpoint[, data, auth, ignore])
Proxy for .request('PUT', ...arguments)
.del(endpoint[, data, auth, ignore])
Proxy for .request('DELETE', ...arguments)
FAQs
Simple handlers for calling Rocket.Chat REST API endpoints.
The npm package @amazebot/rocket-rest receives a total of 1 weekly downloads. As such, @amazebot/rocket-rest popularity was classified as not popular.
We found that @amazebot/rocket-rest demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.