Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions<DataImmutable, DataMutable>

Type parameters

  • DataImmutable

  • DataMutable: DataImmutable

Hierarchy

Index

Properties

Optional count

count: undefined | number

The number of future formations to retrieve when a cache miss occurs. Defaults to the server amount which is usually 32

endpoint

endpoint: UrlThunk

The GraphQL endpoint. Often https://host.com/graphql

factory

factory: Factory<DataImmutable, DataMutable>

The factory that is used to convert and validate the formations data

Optional formationsConvert

formationsConvert: ConvertFormationsFunction<DataImmutable, DataMutable>

Used to convert the JSON returned from the formations query into the actual formation classes

Optional formationsQuery

formationsQuery: undefined | string

The query used to retrieve the formations data. Not required @ef-carbon/graphql-type-conversation formation connection is mounted at formationsConnection

Optional headers

headers: HeadersInit

Headers that will be added to each GraphQL request

Optional startConvert

startConvert: ConvertStartFunction

Used to convert the JSON returned from the starting formation query into the actual GUID class

Optional startQuery

startQuery: undefined | string

The query used to retrieve the starting formation. Not required @ef-carbon/graphql-type-conversation formation connection is mounted at formationsConnection