Documentation
    Preparing search index...

    Interface RouteRule

    Rule governing access to a specific URI route pattern and semantic actions (READ, WRITE, UPDATE, DELETE).

    interface RouteRule {
        access: AccessDecision;
        actions?: (
            | "READ"
            | "WRITE"
            | "CREATE"
            | "UPDATE"
            | "DELETE"
            | "EXECUTE"
            | "MANAGE"
            | "*"
            | "GET"
            | "POST"
            | "PUT"
            | "PATCH"
            | "OPTIONS"
            | "HEAD"
        )[];
        description?: string;
        methods?: (
            | "READ"
            | "WRITE"
            | "CREATE"
            | "UPDATE"
            | "DELETE"
            | "EXECUTE"
            | "MANAGE"
            | "*"
            | "GET"
            | "POST"
            | "PUT"
            | "PATCH"
            | "OPTIONS"
            | "HEAD"
        )[];
        pattern: string;
    }
    Index

    Properties

    access actions? description? methods? pattern

    Properties

    access: AccessDecision

    Explicit authorization decision.

    actions?: (
        | "READ"
        | "WRITE"
        | "CREATE"
        | "UPDATE"
        | "DELETE"
        | "EXECUTE"
        | "MANAGE"
        | "*"
        | "GET"
        | "POST"
        | "PUT"
        | "PATCH"
        | "OPTIONS"
        | "HEAD"
    )[]

    Targeted semantic actions (e.g. ['READ'], ['WRITE', 'UPDATE'], ['*']). Also accepts transport HTTP methods for seamless backward compatibility.

    description?: string

    Optional human-readable rationale or description.

    methods?: (
        | "READ"
        | "WRITE"
        | "CREATE"
        | "UPDATE"
        | "DELETE"
        | "EXECUTE"
        | "MANAGE"
        | "*"
        | "GET"
        | "POST"
        | "PUT"
        | "PATCH"
        | "OPTIONS"
        | "HEAD"
    )[]

    Alias for actions

    pattern: string

    Glob-like URI pattern (e.g. "/api/curate/", "/admin/*", "/")

    Settings

    Member Visibility

    On This Page

    Properties