Cereal docs
TypeScript SDKTypeScript signatures

CerealOptions

Public TypeScript declaration from @trycereal/sdk.

Import from @trycereal/sdk. Generated from the repository SDK declarations (package version 0.0.0); not from HTTP request schemas.

export interface CerealOptions extends CerealClientOptions {
    readonly publicUrl?: string | undefined;
    readonly devMode?: boolean;
    readonly transport?: "http" | "channel";
    readonly channel?: Omit<CerealDevOptions, "client" | "sync" | "apiKey">;
}

See SDK setup, authoring, client behavior, and the API/SDK map for usage. Domain types are described in schema reference.

Related SDK types: CerealDevOptions, CerealClientOptions.