Documentação Bando

Cliente TypeScript

Consome o Bando através do cliente TypeScript oficial.

Por que usar o cliente TypeScript?

O Bando possui uma API REST que pode ser consumida diretamente por HTTP. O cliente TypeScript é uma camada de conveniência que evita teres de construir manualmente todas essas requests.

Se já estás habituado a trabalhar com fetch, pensa no cliente como uma interface tipada sobre a API do Bando.

Gera a API Key

Para consumir endpoints protegidos do Bando, precisas de uma API Key. Se ainda não tens uma, podes gerar uma através do CLI:

npx bando key

Se utilizas pnpm, podes executar o mesmo comando com:

pnpm bando key

A chave gerada deve ser configurada no ambiente onde o cliente será executado.

Configura o cliente

Depois de gerar a key, cria o cliente indicando o endereço da API e a chave utilizada para autenticação.

import { createBandoClient } from "bando-cms";

export const bando = createBandoClient({

baseUrl: process.env.BANDO_URL!,

apiKey: process.env.BANDO_API_KEY!,

});

O que é o createBandoClient?

createBandoClient() cria uma instância que sabe onde está a API do Bando e como autenticar as requests.

baseUrl indica o endereço onde o Bando está a correr.

A API Key é enviada para autenticar as requests que precisam de acesso protegido.

Trabalhando com uma collection

Depois de criar o cliente, podes obter uma collection através do método collection():

const posts = bando.collection<Post>("posts");

A partir daí podes utilizar os métodos disponíveis para consultar e alterar documentos:

await posts.findMany(...)

await posts.findById(...)

await posts.create(...)

await posts.update(...)

await posts.delete(...)

Cada método corresponde a uma operação diferente sobre os documentos.

Aprender findMany() →
Aprender mutations →