@legacy

Documentation / @warp-drive/legacy / model-fragments / withFragmentArrayDefaults

Function: withFragmentArrayDefaults()

function withFragmentArrayDefaults<FragmentArrayType, FragmentArrayName>(fragmentArrayType, fragmentArrayName?): object;

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

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

Type Parameters

FragmentArrayType

FragmentArrayType extends string

FragmentArrayName

FragmentArrayName extends string

Parameters

fragmentArrayType

FragmentArrayType

The type of the fragment-array

fragmentArrayName?

FragmentArrayName

The name of the fragment-array

Returns

object

The schema for a fragment-array

kind

kind: "schema-array";

name

name: string;

options

options: object;

options.arrayExtensions

arrayExtensions: string[];

options.defaultValue

defaultValue: boolean;

type

type: `fragment:${string}`;