Variable createWebConst

Type declaration

• • <T extends Record<string, any> = any, const Id extends string = string>(
        definition: Readonly<
            {
                filter: Filter<T>;
                id: [Path<Id>] extends [never]
                    ? `Invalid id "${Id}": final segment must be camelCase — letters and digits, starting with a letter`
                    : Id;
                position?: number;
                tagName: string;
            },
        >,
    ): Readonly<
        {
            filter?: (data: Record<string, unknown>, role?: string) => data is T;
            id: string;
            kind: "web-component";
            position?: number;
            role: string | string[];
            tagName: string;
        },
    >

  • Creates a Web Component surface definition from a typed filter.

    Type Parameters

    • T extends Record<string, any> = any
    • const Id extends string = string

    Parameters

    • definition: Readonly<
          {
              filter: Filter<T>;
              id: [Path<Id>] extends [never]
                  ? `Invalid id "${Id}": final segment must be camelCase — letters and digits, starting with a letter`
                  : Id;
              position?: number;
              tagName: string;
          },
      >

    Returns Readonly<
        {
            filter?: (data: Record<string, unknown>, role?: string) => data is T;
            id: string;
            kind: "web-component";
            position?: number;
            role: string | string[];
            tagName: string;
        },
    >