@absinthe/socket/src/notifier/types.js

Absinthe Socket

// @flow

import type {
  GqlOperationType,
  GqlRequest
} from "@jumpn/utils-graphql/compat/cjs/types";

import eventNames from "./event/eventNames";

import type {EventName} from "./event/eventNames";
import type {RequestStatus} from "./requestStatuses";

type Observer<Result, Variables: void | Object = void> = {|
  onAbort?: (error: Error) => any,
  onCancel?: () => any,
  onError?: (error: Error) => any,
  onStart?: (notifier: Notifier<Result, Variables>) => any,
  onResult?: (result: Result) => any
|};

type Notifier<Result, Variables: void | Object = void> = {|
  activeObservers: $ReadOnlyArray<Observer<Result, Variables>>,
  canceledObservers: $ReadOnlyArray<Observer<Result, Variables>>,
  isActive: boolean,
  operationType: GqlOperationType,
  request: GqlRequest<Variables>,
  requestStatus: RequestStatus,
  subscriptionId?: string
|};

type EventWith<Name: EventName, Payload = void> = {|
  name: Name,
  payload: Payload
|};

type StartEvent<Payload: Notifier<any, any>> = EventWith<
  typeof eventNames.start,
  Payload
>;

type ResultEvent<Result> = EventWith<typeof eventNames.result, Result>;

type ErrorEvent = EventWith<typeof eventNames.error, Error>;

type CancelEvent = EventWith<typeof eventNames.cancel>;

type AbortEvent = EventWith<typeof eventNames.abort, Error>;

type Event =
  | AbortEvent
  | CancelEvent
  | ErrorEvent
  | ResultEvent<any>
  | StartEvent<any>;

export type {
  AbortEvent,
  CancelEvent,
  ErrorEvent,
  Event,
  ResultEvent,
  StartEvent,
  Notifier,
  Observer
};