Interface RouteObject

Interface for the route object.

interface RouteObject {
    create: (
        routeOrOpts: string | RouteNodeOptions,
        childrenOrOpts?: RouteNodeOptions | RouteChildren,
        children?: Router | RouteChildren,
    ) => Router;
    intents: (base: string) => Router;
    scope(
        scopeName: string,
        routeOrOpts: string | RouteNodeOptions,
        childrenOrOpts?: RouteNodeOptions | RouteChildren,
        children?: Router | RouteChildren,
    ): Router;
}

Index

Methods

Properties

Methods

scope

scope(
    scopeName: string,
    routeOrOpts: string | RouteNodeOptions,
    childrenOrOpts?: RouteNodeOptions | RouteChildren,
    children?: Router | RouteChildren,
): Router
Creates a new router scope. Returns Router
Parameters
- scopeName: string
- routeOrOpts: string | RouteNodeOptions
- OptionalchildrenOrOpts: RouteNodeOptions | RouteChildren
- Optionalchildren: Router | RouteChildren
Returns Router
- Defined in packages/sanity/src/router/route.ts:67

Properties

create

create: (
    routeOrOpts: string | RouteNodeOptions,
    childrenOrOpts?: RouteNodeOptions | RouteChildren,
    children?: Router | RouteChildren,
) => Router

Creates a new router. Returns Router See RouteNodeOptions and RouteChildren

intents

intents: (base: string) => Router

Creates a new router for handling intents. Returns Router