module@warp-drive/legacy/model-fragments @legacy

Function withArrayDefaults()

function withArrayDefaults<ArrayName extends string, PrimitiveType extends string>(arrayName: ArrayName, primitiveType?: PrimitiveType): PrimitiveType extends undefined ? {
  kind: "array";
  name: ArrayName;
  options: {
     arrayExtensions: string[];
  };
  type: "array";
} : {
  kind: "array";
  name: ArrayName;
  options: {
     arrayExtensions: string[];
  };
  type: `array:${PrimitiveType}`;
};

Defined in: warp-drive-packages/legacy/src/model-fragments/utilities/with-array-defaults.ts:11

Used as a helper to setup the relevant parts of an array schema and add extensions etc.

Type Parameters

ArrayName

ArrayName extends string

PrimitiveType

PrimitiveType extends string

Parameters

arrayName

ArrayName

The name of the array

primitiveType?

PrimitiveType

The primitive type of items in the array (optional)

Returns

PrimitiveType extends undefined ? { kind: "array"; name: ArrayName; options: { arrayExtensions: string[]; }; type: "array"; } : { kind: "array"; name: ArrayName; options: { arrayExtensions: string[]; }; type: `array:${PrimitiveType}`; }

The schema for an array