Stone.js API
    Preparing search index...

    Interface DerivationRegistries

    How to resolve what a route declared, when it named something instead of inlining it.

    interface DerivationRegistries {
        fragmentParam?: string;
        onSkipped?: (
            skipped: {
                concern: "status" | "validation" | "resource" | "auth" | "authz";
                reason: string;
                route: string;
            },
        ) => void;
        resolve?: (target: any) => unknown;
        resources?: Record<string, unknown>;
        schemas?: Record<string, unknown>;
        securityScheme?: string;
    }
    Index
    fragmentParam? onSkipped? resolve? resources? schemas? securityScheme?
    fragmentParam?: string

    The query parameter a caller selects a fragment with, as the application named it.

    Read from stone.resources.params.fragment, so a contract never advertises a parameter the application does not answer to. Defaults to view.

    onSkipped?: (
        skipped: {
            concern: "status" | "validation" | "resource" | "auth" | "authz";
            reason: string;
            route: string;
        },
    ) => void

    Told when a declaration could not be read, so an absent payload is visible rather than silent.

    Omitting a contract we could not build is the right call — a wrong contract is worse than a missing one — but doing it without a word means an endpoint quietly ships undocumented. This is how the CLI and the handler report it.

    resolve?: (target: any) => unknown

    How to build a schema class, normally the container.

    With it, a class whose rules() needs a service gets that service, so every declared schema is readable and the contract is complete. Without it, such a class cannot be read and is skipped: a wrong contract is worse than a missing one.

    resources?: Record<string, unknown>

    Named resources, so a route saying resource: 'user' can be read.

    Comes from stone.resources.registry, the same registry the runtime projects through, so the documented response and the sent response are derived from one declaration.

    schemas?: Record<string, unknown>

    stone.validation.schemas: alias to rule set, schema class, or schema.

    securityScheme?: string

    The security scheme name to require when a route declares auth.

    Settings
    Member Visibility

    On This Page
    Properties