Function relative

relative(
    directory: string,
): {
    index: (file: string, options?: CreateIndexOptions) => RouteConfigEntry;
    layout: {
        (file: string, children?: RouteConfigEntry[]): RouteConfigEntry;
        (
            file: string,
            options: CreateLayoutOptions,
            children?: RouteConfigEntry[],
        ): RouteConfigEntry;
    };
    prefix: (
        prefixPath: string,
        routes: RouteConfigEntry[],
    ) => RouteConfigEntry[];
    route: {
        (
            path: undefined | null | string,
            file: string,
            children?: RouteConfigEntry[],
        ): RouteConfigEntry;
        (
            path: undefined | null | string,
            file: string,
            options: CreateRouteOptions,
            children?: RouteConfigEntry[],
        ): RouteConfigEntry;
    };
}
Creates a set of route config helpers that resolve file paths relative to the given directory, for use within routes.ts. This is designed to support splitting route config into multiple files within different directories.
Parameters
- directory: string
Returns {
    index: (file: string, options?: CreateIndexOptions) => RouteConfigEntry;
    layout: {
        (file: string, children?: RouteConfigEntry[]): RouteConfigEntry;
        (
            file: string,
            options: CreateLayoutOptions,
            children?: RouteConfigEntry[],
        ): RouteConfigEntry;
    };
    prefix: (
        prefixPath: string,
        routes: RouteConfigEntry[],
    ) => RouteConfigEntry[];
    route: {
        (
            path: undefined | null | string,
            file: string,
            children?: RouteConfigEntry[],
        ): RouteConfigEntry;
        (
            path: undefined | null | string,
            file: string,
            options: CreateRouteOptions,
            children?: RouteConfigEntry[],
        ): RouteConfigEntry;
    };
}
- index: (file: string, options?: CreateIndexOptions) => RouteConfigEntry
- layout: {
      (file: string, children?: RouteConfigEntry[]): RouteConfigEntry;
      (
          file: string,
          options: CreateLayoutOptions,
          children?: RouteConfigEntry[],
      ): RouteConfigEntry;
  }
- prefix: (prefixPath: string, routes: RouteConfigEntry[]) => RouteConfigEntry[]
- route: {
      (
          path: undefined | null | string,
          file: string,
          children?: RouteConfigEntry[],
      ): RouteConfigEntry;
      (
          path: undefined | null | string,
          file: string,
          options: CreateRouteOptions,
          children?: RouteConfigEntry[],
      ): RouteConfigEntry;
  }
- Defined in config/routes.ts:320

Function relative

Parameters

index: (file: string, options?: CreateIndexOptions) => RouteConfigEntry

layout: { (file: string, children?: RouteConfigEntry[]): RouteConfigEntry; ( file: string, options: CreateLayoutOptions, children?: RouteConfigEntry[], ): RouteConfigEntry;}

prefix: (prefixPath: string, routes: RouteConfigEntry[]) => RouteConfigEntry[]

route: { ( path: undefined | null | string, file: string, children?: RouteConfigEntry[], ): RouteConfigEntry; ( path: undefined | null | string, file: string, options: CreateRouteOptions, children?: RouteConfigEntry[], ): RouteConfigEntry;}

Settings

layout: {
(file: string, children?: RouteConfigEntry[]): RouteConfigEntry;
(
file: string,
options: CreateLayoutOptions,
children?: RouteConfigEntry[],
): RouteConfigEntry;
}

route: {
(
path: undefined | null | string,
file: string,
children?: RouteConfigEntry[],
): RouteConfigEntry;
(
path: undefined | null | string,
file: string,
options: CreateRouteOptions,
children?: RouteConfigEntry[],
): RouteConfigEntry;
}