@legacy

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

Function: withFragmentDefaults()

function withFragmentDefaults<FragmentType, FragmentName>(fragmentType, fragmentName?): object;

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

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

Type Parameters

FragmentType

FragmentType extends string

FragmentName

FragmentName extends string

Parameters

fragmentType

FragmentType

The type of the fragment

fragmentName?

FragmentName

The optional name of the fragment. If not provided, it will default to the fragmentType.

Returns

object

The schema for a fragment

kind

kind: "schema-object";

name

name: FragmentType | FragmentName;

options

options: object;

options.objectExtensions

objectExtensions: string[];

type

type: `fragment:${FragmentType}`;