Interface PlanVortexOptions

interface PlanVortexOptions {
    accessToken?: string;
    baseUrl?: string;
    clientId?: string;
    clientSecret?: string;
    dangerouslyAllowBrowser?: boolean;
    fetch?: FetchLike;
    hooks?: HttpHooks;
    retry?: Partial<RetryConfig>;
    scope?: string;
    timeoutMs?: number;
}

Properties

accessToken? baseUrl? clientId? clientSecret? dangerouslyAllowBrowser? fetch? hooks? retry? scope? timeoutMs?

Properties

OptionalaccessToken

accessToken?: string

Un token ya emitido, en vez de credenciales: el temporal_connect_token con el que una persona conecta su cuenta social. No se refresca solo (§ trampa 2 del roadmap).

OptionalbaseUrl

baseUrl?: string

Por defecto https://api.planvortex.com/v1.0.0. Sin barra final.

OptionalclientId

clientId?: string

El identificador de la app de cliente. Por defecto, process.env.PLANVORTEX_CLIENT_ID.

OptionalclientSecret

clientSecret?: string

El secreto de la app. Por defecto, process.env.PLANVORTEX_CLIENT_SECRET.

OptionaldangerouslyAllowBrowser

dangerouslyAllowBrowser?: boolean

Deja construir el cliente en un navegador. No lo pongas. El client_credentials exige el client_secret, y un secreto en un bundle de front es la cuenta entera regalada (§ trampa 9). Para el navegador existe el token temporal de conexión.

Optionalfetch

fetch?: FetchLike

fetch alternativo: un proxy, un mock, una implementación instrumentada.

Optionalhooks

hooks?: HttpHooks

onRequest / onResponse / onRetry, para enchufar el logger de casa.

Optionalretry

retry?: Partial<RetryConfig>

Optionalscope

scope?: string

scope opcional del client_credentials. Casi nadie lo necesita.

OptionaltimeoutMs

timeoutMs?: number

Timeout por petición. 120 s por defecto: publicar un vídeo es lento.

Settings

Member Visibility

On This Page

Properties