npm
npm install @beamcloud/beam-js
yarn
yarn add @beamcloud/beam-js
import beam from "@beamcloud/beam-js";
const client = await beam.init("YOUR_BEAM_TOKEN");
Deployments
list
const deployments = await client.deployments.list();
get
const deployment = await client.deployments.get("DEPLOYMENT_ID");
delete
await client.deployments.delete("DEPLOYMENT_ID");
refresh
const deployment = await client.deployments.get("DEPLOYMENT_ID"); await deployment.refresh();
call
await client.deployments.call("DEPLOYMENT_ID");
realtime
const stream = deployment.realtime(); stream.on("data", (data) => { console.log(data); });
import beam from "@beamcloud/beam-js"; const streamResponse = async () => { const client = await beam.init(process.env.BEAM_TOKEN); const deployment = await client.deployments.get({ id: process.env.BEAM_DEPLOYMENT_ID, }); const connection = await deployment.realtime(); const payload = { event: "Echo this back", }; connection.onmessage = (message) => { console.log(`🎉 Response: ${message.data}`); }; connection.send(JSON.stringify(payload)); setTimeout(() => { connection.close(); }, 1000); }; streamResponse();
Tasks
const tasks = await client.tasks.list();
const task = await client.tasks.get("TASK_ID"); console.log(task.data);
await client.tasks.delete("TASK_ID");
cancel
const task = await client.tasks.get("TASK_ID"); await task.cancel();
const task = await client.tasks.get("TASK_ID"); await task.refresh();
Was this page helpful?