JavaScript SDK

Use o SDK no browser ou Node para falar com a API e assinar eventos em tempo real.

Instalação

npm bash

npm install onlybase-sdk

npm install onlybase-sdk

bun bash

bun add onlybase-sdk

bun add onlybase-sdk

Quick start

Crie um cliente com sua API key. Aponte baseUrl para sua API (ex. https://api.onlybase.app em produção).

Browser or Node javascript

import { only } from 'onlybase-sdk';

const apiKey = 'YOUR_API_KEY';

const users = only(apiKey).collection('users');

import { only } from 'onlybase-sdk';

const apiKey = 'YOUR_API_KEY';

const users = only(apiKey).collection('users');

Coleções

Todos os métodos retornam uma Promise. As respostas têm um formato data (e opcional error ).

Criar linha(s)

const result = await users.create({ email: 'a@b.com', name: 'Alice' });
// or array: await users.create([{ email: 'a@b.com' }, { email: 'b@c.com' }]);

const result = await users.create({ email: 'a@b.com', name: 'Alice' });
// or array: await users.create([{ email: 'a@b.com' }, { email: 'b@c.com' }]);

Listar linhas

const { data } = await users.list({
  limit: 100,
  offset: 0,
  orderBy: 'id',
  order: 'desc'
});

const { data } = await users.list({
  limit: 100,
  offset: 0,
  orderBy: 'id',
  order: 'desc'
});

Obter uma linha

const { data } = await users.one('1');

const { data } = await users.one('1');

Atualizar linha

await users.update('1', { name: 'Alice Updated' });

await users.update('1', { name: 'Alice Updated' });

Excluir linha

await users.delete('1');

await users.delete('1');

Tempo real

Inscreva-se em eventos insert, update ou delete. O SDK conecta via WebSocket e reconecta automaticamente. Chame unsubscribe() para fechar.

Subscribe javascript

const sub = users.subscribe('insert', (message) => {
  console.log(message.event, message.collection, message.payload);
});

// later
sub.unsubscribe();

const sub = users.subscribe('insert', (message) => {
  console.log(message.event, message.collection, message.payload);
});

// later
sub.unsubscribe();

Eventos: 'insert', 'update', 'delete'.