Skip to main content
Version: 1.x.x

getCommandManagerEvents


import { getCommandManagerEvents } from "@hyper-fetch/core"

Description

Defined in managers/command/command.manager.events.ts:27

Preview

getCommandManagerEvents(emitter)

Parameters

NameDetails

emitter

Required

EventEmitter

Returns

{
emitAbort: (abortKey: string, requestId: string, command: CommandInstance) => void;
emitDownloadProgress: (queueKey: string, requestId: string, values: FetchProgressType, details: CommandEventDetails<CommandInstance>) => void;
emitLoading: (queueKey: string, requestId: string, values: CommandLoadingEventType) => void;
emitRemove: (queueKey: string, requestId: string, details: CommandEventDetails<T>) => void;
emitRequestStart: (queueKey: string, requestId: string, details: CommandEventDetails<CommandInstance>) => void;
emitResponse: (cacheKey: string, requestId: string, response: ClientResponseType<unknown, unknown>, details: CommandResponseDetails) => void;
emitResponseStart: (queueKey: string, requestId: string, details: CommandEventDetails<CommandInstance>) => void;
emitUploadProgress: (queueKey: string, requestId: string, values: FetchProgressType, details: CommandEventDetails<CommandInstance>) => void;
onAbort: (abortKey: string, callback: (command: CommandInstance) => void) => VoidFunction;
onAbortById: (requestId: string, callback: (command: CommandInstance) => void) => VoidFunction;
onDownloadProgress: (queueKey: string, callback: (values: FetchProgressType, details: CommandEventDetails<T>) => void) => VoidFunction;
onDownloadProgressById: (requestId: string, callback: (values: FetchProgressType, details: CommandEventDetails<T>) => void) => VoidFunction;
onLoading: (queueKey: string, callback: (values: CommandLoadingEventType) => void) => VoidFunction;
onLoadingById: (requestId: string, callback: (values: CommandLoadingEventType) => void) => VoidFunction;
onRemove: (queueKey: string, callback: (details: CommandEventDetails<T>) => void) => VoidFunction;
onRemoveById: (requestId: string, callback: (details: CommandEventDetails<T>) => void) => VoidFunction;
onRequestStart: (queueKey: string, callback: (details: CommandEventDetails<T>) => void) => VoidFunction;
onRequestStartById: (requestId: string, callback: (details: CommandEventDetails<T>) => void) => VoidFunction;
onResponse: (cacheKey: string, callback: (response: ClientResponseType<ResponseType, ErrorType>, details: CommandResponseDetails) => void) => VoidFunction;
onResponseById: (requestId: string, callback: (response: ClientResponseType<ResponseType, ErrorType>, details: CommandResponseDetails) => void) => VoidFunction;
onResponseStart: (queueKey: string, callback: (details: CommandEventDetails<T>) => void) => VoidFunction;
onResponseStartById: (requestId: string, callback: (details: CommandEventDetails<T>) => void) => VoidFunction;
onUploadProgress: (queueKey: string, callback: (values: FetchProgressType, details: CommandEventDetails<T>) => void) => VoidFunction;
onUploadProgressById: (requestId: string, callback: (values: FetchProgressType, details: CommandEventDetails<T>) => void) => VoidFunction;
}