Type Alias CapsuleContext<Schema>

Runtime-owned context passed to queries, mutations, endpoints, messages, middleware, and hooks.

type CapsuleContext<Schema extends SchemaDefinition = SchemaDefinition> = {
    auth: AuthContext;
    db: DatabaseFromSchema<Schema>;
    env: Record<string, string>;
    jobs: JobApi;
    log: Logger;
    mail: MailApi;
    messages: MessageApi;
    privileged: PrivilegedApi<Schema>;
    serverAuth: ServerAuthApi;
    teams: CurrentUserTeamsApi;
}

Type Parameters

Schema extends SchemaDefinition = SchemaDefinition

Index

Properties

auth db env jobs log mail messages privileged serverAuth teams

Properties

auth

auth: AuthContext

db

db: DatabaseFromSchema<Schema>

env

env: Record<string, string>

jobs

jobs: JobApi

Server-only current-user durable Job Queue.

log

mail

Server-only SMTP delivery. Present even when mail is disabled.

messages

messages: MessageApi

privileged

privileged: PrivilegedApi<Schema>

serverAuth

serverAuth: ServerAuthApi

Server-only auth management (e.g. password reset).

teams

teams: CurrentUserTeamsApi

Runtime-owned current-user Teams with normal linked-user authorization.