InstantBackend SDK

SDK oficial de JavaScript para InstantBackend - Una API backend simplificada con autenticación y gestión de colecciones.

Instalación

npm install @instantbackend.dev/instantbackend-sdk

Uso

Importación

// ES6 Modules
import { InstantBackend } from '@instantbackend.dev/instantbackend-sdk';

// CommonJS
const { InstantBackend } = require('@instantbackend.dev/instantbackend-sdk');

Inicialización

const sdk = new InstantBackend('tu-api-key');

Autenticación

// Login de usuario
const authResponse = await sdk.login('username', 'password');
// El token JWT se almacena automáticamente en la instancia

Gestión de Colecciones

// Obtener una referencia a una colección
const users = sdk.collection('users');

// Agregar un documento
const newUser = await users.add({
  name: 'Juan',
  email: '[email protected]'
});

// Consultar documentos con filtros
const results = await users
  .where('email', '==', '[email protected]')
  .limit(10)
  .sort('asc')
  .get();

// Obtener un documento por ID
const user = await users.doc('document-id');

API Reference

InstantBackend

Constructor

new InstantBackend(apiKey, jwtToken?)

• apiKey (string, requerido): Tu API key de InstantBackend
• jwtToken (string, opcional): Token JWT para autenticación

Métodos

• collection(name): Obtiene una referencia a una colección
• login(username, password): Autentica un usuario y obtiene un token

Collection

Métodos

• add(data): Agrega un documento a la colección
• where(field, operator, value): Agrega un filtro a la consulta
• limit(n): Limita el número de resultados
• sort(order): Establece el orden de clasificación ('asc' o 'desc')
• nextToken(token): Establece el token de paginación
• get(): Ejecuta la consulta y obtiene los resultados
• doc(id): Obtiene un documento por su ID

Licencia

MIT