<internal> | helyOS-JavaScript-SDK

Index

Namespaces

Enumerations

Interfaces

Type aliases

Variables

Type aliases

ASTNode

The list of all possible AST node types.

ApolloClientOptions

ApolloClientOptions<TCacheShape>: { assumeImmutableResults?: boolean; cache: ApolloCache<TCacheShape>; connectToDevTools?: boolean; defaultOptions?: DefaultOptions; fragmentMatcher?: FragmentMatcher; link?: ApolloLink; name?: string; queryDeduplication?: boolean; resolvers?: Resolvers | Resolvers[]; ssrForceFetchDelay?: number; ssrMode?: boolean; typeDefs?: string | string[] | DocumentNode | DocumentNode[]; version?: string }

Type parameters

TCacheShape

Type declaration

Optional assumeImmutableResults?: boolean
cache: ApolloCache<TCacheShape>
Optional connectToDevTools?: boolean
Optional defaultOptions?: DefaultOptions
Optional fragmentMatcher?: FragmentMatcher
Optional link?: ApolloLink
Optional name?: string
Optional queryDeduplication?: boolean
Optional resolvers?: Resolvers | Resolvers[]
Optional ssrForceFetchDelay?: number
Optional ssrMode?: boolean
Optional typeDefs?: string | string[] | DocumentNode | DocumentNode[]
Optional version?: string

ApolloCurrentQueryResult

ApolloCurrentQueryResult<T>: { data: T | undefined; error?: ApolloError; errors?: ReadonlyArray<GraphQLError>; loading: boolean; networkStatus: NetworkStatus; partial?: boolean; stale?: boolean }

Type parameters

Type declaration

data: T | undefined
Optional error?: ApolloError
Optional errors?: ReadonlyArray<GraphQLError>
loading: boolean
networkStatus: NetworkStatus
Optional partial?: boolean
Optional stale?: boolean

ApolloCurrentResult

ApolloCurrentResult<T>: { data: T | {}; error?: ApolloError; errors?: ReadonlyArray<GraphQLError>; loading: boolean; networkStatus: NetworkStatus; partial?: boolean }

Type parameters

Type declaration

data: T | {}
Optional error?: ApolloError
Optional errors?: ReadonlyArray<GraphQLError>
loading: boolean
networkStatus: NetworkStatus
Optional partial?: boolean

ApolloQueryResult

ApolloQueryResult<T>: { data: T; errors?: ReadonlyArray<GraphQLError>; loading: boolean; networkStatus: NetworkStatus; stale: boolean }

Type parameters

Type declaration

data: T
Optional errors?: ReadonlyArray<GraphQLError>
loading: boolean
networkStatus: NetworkStatus
stale: boolean

ArrayBufferLike

ArrayBufferLike: ArrayBufferTypes[keyof ArrayBufferTypes]

BodyInit

BufferSource

BufferSource: ArrayBufferView | ArrayBuffer

DefinitionNode

DefinitionNode: ExecutableDefinitionNode | TypeSystemDefinitionNode | TypeSystemExtensionNode

ErrorPolicy

ErrorPolicy: "none" | "ignore" | "all"

EventListenerOrEventListenerObject

EventListenerOrEventListenerObject: EventListener | EventListenerObject

ExecutableDefinitionNode

ExecutableDefinitionNode: OperationDefinitionNode | FragmentDefinitionNode

FetchPolicy

FetchPolicy: "cache-first" | "network-only" | "cache-only" | "no-cache" | "standby"

FetchResult

FetchResult<TData, C, E>: ExecutionResult<TData> & { context?: C; extensions?: E }

Type parameters

TData = {}
C = Record<string, any>
E = Record<string, any>

FormDataEntryValue

FormDataEntryValue: <internal>.File | string

FragmentMatcher

FragmentMatcher: (rootValue: any, typeCondition: string, context: any) => boolean

Type declaration

- (rootValue: any, typeCondition: string, context: any): boolean
- Parameters
  - rootValue: any
  - typeCondition: string
  - context: any
  Returns boolean

HeadersInit

HeadersInit: <internal>.Headers | string[][] | Record<string, string>

LocalStateOptions

LocalStateOptions<TCacheShape>: { cache: ApolloCache<TCacheShape>; client?: default<TCacheShape>; fragmentMatcher?: FragmentMatcher; resolvers?: Resolvers | Resolvers[] }

Type parameters

TCacheShape

Type declaration

cache: ApolloCache<TCacheShape>
Optional client?: default<TCacheShape>
Optional fragmentMatcher?: FragmentMatcher
Optional resolvers?: Resolvers | Resolvers[]

MutationQueryReducer

MutationQueryReducer<T>: (previousResult: Record<string, any>, options: { mutationResult: FetchResult<T>; queryName: string | undefined; queryVariables: Record<string, any> }) => Record<string, any>

Type parameters

Type declaration

- (previousResult: Record<string, any>, options: { mutationResult: FetchResult<T>; queryName: string | undefined; queryVariables: Record<string, any> }): Record<string, any>
- Parameters
  - previousResult: Record<string, any>
  - options: { mutationResult: FetchResult<T>; queryName: string | undefined; queryVariables: Record<string, any> }
    - mutationResult: FetchResult<T>
    - queryName: string | undefined
    - queryVariables: Record<string, any>
  Returns Record<string, any>

MutationQueryReducersMap

MutationQueryReducersMap<T>: {}

Type parameters

T = {}

Type declaration

[queryName: string]: MutationQueryReducer<T>

MutationUpdaterFn

MutationUpdaterFn<T>: (proxy: DataProxy, mutationResult: FetchResult<T>) => void

Type parameters

T = {}

Type declaration

- (proxy: DataProxy, mutationResult: FetchResult<T>): void
- Parameters
  - proxy: DataProxy
  - mutationResult: FetchResult<T>
  Returns void

Type parameters

OperationTypeNode

OperationTypeNode: "query" | "mutation" | "subscription"

OperationVariables

OperationVariables: {}

Type declaration

[key: string]: any

Partial

Partial<T>: { [ P in keyof T]?: T[P] }

Make all properties in T optional

Type parameters

Pick

Pick<T, K>: { [ P in K]: T[P] }

From T, pick a set of properties whose keys are in the union K

Type parameters

T
K: keyof T

PropertyKey

PropertyKey: string | number | symbol

PureQueryOptions

PureQueryOptions: { context?: any; query: DocumentNode; variables?: {} }

Type declaration

Optional context?: any
query: DocumentNode
Optional variables?: {}
- [key: string]: any

QueryListener

QueryListener: (queryStoreValue: QueryStoreValue, newData?: any, forceResolvers?: boolean) => void

Type declaration

- (queryStoreValue: QueryStoreValue, newData?: any, forceResolvers?: boolean): void
- Parameters
  - queryStoreValue: QueryStoreValue
  - Optional newData: any
  - Optional forceResolvers: boolean
  Returns void

QueryStoreValue

QueryStoreValue: { document: DocumentNode; graphQLErrors?: ReadonlyArray<GraphQLError>; metadata: any; networkError?: Error | null; networkStatus: NetworkStatus; previousVariables?: <internal>.Object | null; variables: <internal>.Object }

Type declaration

document: DocumentNode
Optional graphQLErrors?: ReadonlyArray<GraphQLError>
metadata: any
Optional networkError?: Error | null
networkStatus: NetworkStatus
Optional previousVariables?: <internal>.Object | null
variables: <internal>.Object

QueryWithUpdater

QueryWithUpdater: { query: QueryStoreValue; updater: MutationQueryReducer<<internal>.Object> }

Type declaration

query: QueryStoreValue
updater: MutationQueryReducer<<internal>.Object>

ReadableStreamDefaultReadResult

ReadableStreamDefaultReadResult<T>: ReadableStreamDefaultReadValueResult<T> | ReadableStreamDefaultReadDoneResult

Type parameters

Readonly

Readonly<T>: { readonly [ P in keyof T]: T[P] }

Make all properties in T readonly

Type parameters

Record

Record<K, T>: { [ P in K]: T }

Construct a type with a set of properties K of type T

Type parameters

K: keyof any
T

ReferrerPolicy

RefetchQueryDescription

RefetchQueryDescription: (string | PureQueryOptions)[]

RequestCache

RequestCredentials

RequestCredentials: "include" | "omit" | "same-origin"

RequestDestination

RequestHandler

RequestHandler: (operation: Operation, forward: NextLink) => <internal>.Observable<FetchResult> | null

Type declaration

- (operation: Operation, forward: NextLink): <internal>.Observable<FetchResult> | null
- Parameters
  - operation: Operation
  - forward: NextLink
  Returns <internal>.Observable<FetchResult> | null

RequestInfo

RequestInfo: <internal>.Request | string

RequestMode

RequestMode: "cors" | "navigate" | "no-cors" | "same-origin"

RequestRedirect

RequestRedirect: "error" | "follow" | "manual"

ResponseType

SchemaExtensionNode

SchemaExtensionNode: { directives?: ReadonlyArray<DirectiveNode>; kind: "SchemaExtension"; loc?: <internal>.Location; operationTypes?: ReadonlyArray<OperationTypeDefinitionNode> }

Type declaration

Optional Readonly directives?: ReadonlyArray<DirectiveNode>
Readonly kind: "SchemaExtension"
Optional Readonly loc?: <internal>.Location
Optional Readonly operationTypes?: ReadonlyArray<OperationTypeDefinitionNode>

SelectionNode

SelectionNode: FieldNode | FragmentSpreadNode | InlineFragmentNode

SubscribeToMoreOptions

SubscribeToMoreOptions<TData, TSubscriptionVariables, TSubscriptionData>: { document: DocumentNode; updateQuery?: UpdateQueryFn<TData, TSubscriptionVariables, TSubscriptionData>; variables?: TSubscriptionVariables; onError?: any }

Type parameters

TData = any
TSubscriptionVariables = OperationVariables
TSubscriptionData = TData

Type declaration

document: DocumentNode
Optional updateQuery?: UpdateQueryFn<TData, TSubscriptionVariables, TSubscriptionData>
Optional variables?: TSubscriptionVariables
onError?:function
- onError(error: Error): void
- - Defined in node_modules/apollo-client/core/watchQueryOptions.d.ts:42
  Parameters
  - error: Error
  Returns void

Subscriber

Subscriber<T>: <internal>.Subscriber<T>

Type parameters

Subscriber

Subscriber<T>: (observer: SubscriptionObserver<T>) => void | (() => void) | <internal>.Subscription

Type parameters

Type declaration

- (observer: SubscriptionObserver<T>): void | (() => void) | <internal>.Subscription
- Parameters
  - observer: SubscriptionObserver<T>
  Returns void | (() => void) | <internal>.Subscription

TokenKindEnum

TokenKindEnum: _TokenKind[keyof _TokenKind]

The enum type representing the token kinds values.

Transaction

Transaction<T>: (c: ApolloCache<T>) => void

Type parameters

Type declaration

- (c: ApolloCache<T>): void
- Parameters
  - c: ApolloCache<T>
  Returns void

TypeDefinitionNode

TypeExtensionNode

TypeNode

TypeNode: NamedTypeNode | ListTypeNode | NonNullTypeNode

TypeSystemDefinitionNode

TypeSystemDefinitionNode: SchemaDefinitionNode | TypeDefinitionNode | DirectiveDefinitionNode

TypeSystemExtensionNode

TypeSystemExtensionNode: SchemaExtensionNode | TypeExtensionNode

UpdateQueryFn

UpdateQueryFn<TData, TSubscriptionVariables, TSubscriptionData>: (previousQueryResult: TData, options: { subscriptionData: { data: TSubscriptionData }; variables?: TSubscriptionVariables }) => TData

Type parameters

TData = any
TSubscriptionVariables = OperationVariables
TSubscriptionData = TData

Type declaration

- (previousQueryResult: TData, options: { subscriptionData: { data: TSubscriptionData }; variables?: TSubscriptionVariables }): TData
- Parameters
  - previousQueryResult: TData
  - options: { subscriptionData: { data: TSubscriptionData }; variables?: TSubscriptionVariables }
    - subscriptionData: { data: TSubscriptionData }
      - data: TSubscriptionData
    - Optional variables?: TSubscriptionVariables
  Returns TData

ValueNode

WatchCallback

WatchCallback: (newData: any) => void

Type declaration

- (newData: any): void
- Parameters
  - newData: any
  Returns void

WatchQueryFetchPolicy

WatchQueryFetchPolicy: FetchPolicy | "cache-and-network"

_TokenKind

_TokenKind: { AMP: "&"; AT: "@"; BANG: "!"; BLOCK_STRING: "BlockString"; BRACE_L: "{"; BRACE_R: "}"; BRACKET_L: "["; BRACKET_R: "]"; COLON: ":"; COMMENT: "Comment"; DOLLAR: "$"; EOF: "<EOF>"; EQUALS: "="; FLOAT: "Float"; INT: "Int"; NAME: "Name"; PAREN_L: "("; PAREN_R: ")"; PIPE: "|"; SOF: "<SOF>"; SPREAD: "..."; STRING: "String" }

Type declaration

AMP: "&"
AT: "@"
BANG: "!"
BLOCK_STRING: "BlockString"
BRACE_L: "{"
BRACE_R: "}"
BRACKET_L: "["
BRACKET_R: "]"
COLON: ":"
COMMENT: "Comment"
DOLLAR: "$"
EOF: "<EOF>"
EQUALS: "="
FLOAT: "Float"
INT: "Int"
NAME: "Name"
PAREN_L: "("
PAREN_R: ")"
PIPE: "|"
SOF: "<SOF>"
SPREAD: "..."
STRING: "String"

Variables

AbortSignal

AbortSignal: { prototype: <internal>.AbortSignal }

Type declaration

prototype: <internal>.AbortSignal

Blob

Blob: { prototype: <internal>.Blob }

Type declaration

prototype: <internal>.Blob

Boolean

Boolean: BooleanConstructor

Event

Event: { AT_TARGET: number; BUBBLING_PHASE: number; CAPTURING_PHASE: number; NONE: number; prototype: <internal>.Event }

Type declaration

Readonly AT_TARGET: number
Readonly BUBBLING_PHASE: number
Readonly CAPTURING_PHASE: number
Readonly NONE: number
prototype: <internal>.Event

EventTarget

EventTarget: { prototype: <internal>.EventTarget }

Type declaration

prototype: <internal>.EventTarget

File

File: { prototype: <internal>.File }

Type declaration

prototype: <internal>.File

FormData

FormData: { prototype: <internal>.FormData }

Type declaration

prototype: <internal>.FormData

Headers

Headers: { prototype: <internal>.Headers }

Type declaration

prototype: <internal>.Headers

Object

Object: ObjectConstructor

Provides functionality common to all JavaScript objects.

Const Observable

Observable: { from: any; of: any }

Type declaration

from:function
- from<R>(observable: <internal>.Observable<R> | ObservableLike<R> | ArrayLike<R>): <internal>.Observable<R>
- - Defined in node_modules/zen-observable-ts/lib/zenObservable.d.ts:8
  Type parameters
  - R
  Parameters
  - observable: <internal>.Observable<R> | ObservableLike<R> | ArrayLike<R>
  Returns <internal>.Observable<R>
of:function
- of<R>(...args: R[]): <internal>.Observable<R>
- - Defined in node_modules/zen-observable-ts/lib/zenObservable.d.ts:9
  Type parameters
  - R
  Parameters
  - Rest ...args: R[]
  Returns <internal>.Observable<R>

ReadableStream

ReadableStream: { prototype: <internal>.ReadableStream<any> }

Type declaration

prototype: <internal>.ReadableStream<any>

ReadableStreamDefaultReader

ReadableStreamDefaultReader: { prototype: <internal>.ReadableStreamDefaultReader<any> }

Type declaration

prototype: <internal>.ReadableStreamDefaultReader<any>

Request

Request: { prototype: <internal>.Request }

Type declaration

prototype: <internal>.Request

Response

Response: { prototype: <internal>.Response; error: any; redirect: any }

Type declaration

prototype: <internal>.Response
error:function
- error(): <internal>.Response
- - Defined in node_modules/typescript/lib/lib.dom.d.ts:12564
  Returns <internal>.Response
redirect:function
- redirect(url: string, status?: number): <internal>.Response
- - Defined in node_modules/typescript/lib/lib.dom.d.ts:12565
  Parameters
  - url: string
  - Optional status: number
  Returns <internal>.Response

URLSearchParams

URLSearchParams: { prototype: <internal>.URLSearchParams; toString: any }

Type declaration

prototype: <internal>.URLSearchParams
toString:function
- toString(): string
- - Defined in node_modules/typescript/lib/lib.dom.d.ts:15817
  Returns string

WritableStream

WritableStream: { prototype: <internal>.WritableStream<any> }

Type declaration

prototype: <internal>.WritableStream<any>

WritableStreamDefaultWriter

WritableStreamDefaultWriter: { prototype: <internal>.WritableStreamDefaultWriter<any> }

Type declaration

prototype: <internal>.WritableStreamDefaultWriter<any>

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Type aliases

ASTNode

ApolloClientOptions

Type parameters

TCacheShape

Type declaration

Optional assumeImmutableResults?: boolean

cache: ApolloCache<TCacheShape>

Optional connectToDevTools?: boolean

Optional defaultOptions?: DefaultOptions

Optional fragmentMatcher?: FragmentMatcher

Optional link?: ApolloLink

Optional name?: string

Optional queryDeduplication?: boolean

Optional resolvers?: Resolvers | Resolvers[]

Optional ssrForceFetchDelay?: number

Optional ssrMode?: boolean

Optional typeDefs?: string | string[] | DocumentNode | DocumentNode[]

Optional version?: string

ApolloCurrentQueryResult

Type parameters

T

Type declaration

data: T | undefined

Optional error?: ApolloError

Optional errors?: ReadonlyArray<GraphQLError>

loading: boolean

networkStatus: NetworkStatus

Optional partial?: boolean

Optional stale?: boolean

ApolloCurrentResult

Type parameters

T

Type declaration

data: T | {}

Optional error?: ApolloError

Optional errors?: ReadonlyArray<GraphQLError>

loading: boolean

networkStatus: NetworkStatus

Optional partial?: boolean

ApolloQueryResult

Type parameters

T

Type declaration

data: T

Optional errors?: ReadonlyArray<GraphQLError>

loading: boolean

networkStatus: NetworkStatus

stale: boolean

ArrayBufferLike

BodyInit

BufferSource

DefinitionNode

ErrorPolicy

EventListenerOrEventListenerObject

ExecutableDefinitionNode

FetchPolicy

FetchResult

Type parameters

TData = {}

C = Record<string, any>

E = Record<string, any>

FormDataEntryValue

FragmentMatcher

Type declaration

Parameters

rootValue: any

typeCondition: string

context: any

Returns boolean

HeadersInit

LocalStateOptions

Type parameters