Documentación

SDK Cliente

Librería JavaScript para integrar feature flags en tus aplicaciones.

Importar
import { getFlags, isFlagEnabled } from 'https://tu-dominio.com/client.js';

getFlags(options)

Obtiene todos los feature flags para un sitio y entorno específicos.

Parámetros
  • token (requerido): Token de autenticación del sitio
  • environment (requerido): Entorno (ej: 'production', 'staging')
  • domain (opcional): Dominio asociado. Se usa automáticamente window.location.hostname si no se especifica
  • apiUrl (opcional): URL del API (por defecto: '/api/flags')
Retorna

Objeto con los flags. Ej: {newFeature: true, betaUI: false}

Ejemplo

const flags = await getFlags({
  token: 'your-token',
  environment: 'production',
  domain: 'example.com'
});

isFlagEnabled(flags, key, fallback?)

Verifica si un feature flag está habilitado. Devuelve un booleano.

Parámetros
  • flags (requerido): Objeto de flags obtenido de getFlags()
  • key (requerido): Clave del flag a verificar
  • fallback (opcional): Valor por defecto si el flag no existe (por defecto: false)

Ejemplo

if (isFlagEnabled(flags, 'newFeature')) {
  // Mostrar nueva funcionalidad
}

Validaciones

  • Se valida que el dominio coincida con window.location.hostname en navegadores
  • Se lanza error si faltan parámetros requeridos: token, environment o domain
  • Se muestra advertencia en consola si hay discrepancia entre el dominio esperado y el actual

Flujo de Integración

  1. Obtener token: Genera un token en el dashboard para tu sitio
  2. Importar librería: Importa el script del cliente en tu aplicación
  3. Llamar getFlags(): Obtén los flags al iniciar tu aplicación
  4. Usar isFlagEnabled(): Verifica estados y ejecuta lógica condicional