Plugin

---

Import

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

Source

View the source code

Package

@hyper-fetch/core

Parameters

class Plugin<Client, PluginData> {
  constructor(config: PluginOptionsType<PluginData>) {};
  name: string;
  data: PluginData;
  config: PluginOptionsType<PluginData>;
  client: undefined | Client;
  initialize(client: Client) => Plugin<Client, PluginData>;
  onAdapterFetch(callback: undefined | (data: { adapter: AdapterInstance; request: RequestInstance; requestId: string }) => void) => Plugin<Client, PluginData>;
  onCacheItemChange(callback: undefined | <Requests>(data: { cache: Cache<ExtractClientAdapterType<Client>>; cacheKey: Requests[cacheKey]; newData: CacheValueType<Requests[response], Requests[error], ExtractClientAdapterType<Client>>; prevData: null | CacheValueType<Requests[response], Requests[error], ExtractClientAdapterType<Client>> }) => void) => Plugin<Client, PluginData>;
  onCacheItemDelete(callback: undefined | (data: { cache: Cache<ExtractClientAdapterType<Client>>; cacheKey: string }) => void) => Plugin<Client, PluginData>;
  onDispatcherCleared(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>> }) => void) => Plugin<Client, PluginData>;
  onDispatcherItemAdded(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>>; queueItem: QueueItemType<ExtendRequest<RequestInstance, { client: Client }>> }) => void) => Plugin<Client, PluginData>;
  onDispatcherItemDeleted(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>>; queueItem: QueueItemType<ExtendRequest<RequestInstance, { client: Client }>> }) => void) => Plugin<Client, PluginData>;
  onDispatcherQueueCleared(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>> }) => void) => Plugin<Client, PluginData>;
  onDispatcherQueueCreated(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>> }) => void) => Plugin<Client, PluginData>;
  onDispatcherQueueDrained(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>> }) => void) => Plugin<Client, PluginData>;
  onDispatcherQueueRunning(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>>; status: paused | stopped | running }) => void) => Plugin<Client, PluginData>;
  onMount(callback: undefined | (data: { client: Client }) => void) => Plugin<Client, PluginData>;
  onRequestCreate(callback: undefined | (data: { request: PluginRequest<Client> }) => void) => Plugin<Client, PluginData>;
  onRequestError(callback: undefined | (data: { request: PluginRequest<Client>; response: ResponseErrorType<any, ExtractClientAdapterType<Client extends ClientInstance ? Client<Client> : ClientInstance>> }) => void) => Plugin<Client, PluginData>;
  onRequestFinished(callback: undefined | (data: { request: PluginRequest<Client>; response: ResponseType<any, any, ExtractClientAdapterType<Client extends ClientInstance ? Client<Client> : ClientInstance>> }) => void) => Plugin<Client, PluginData>;
  onRequestStart(callback: undefined | (data: { request: PluginRequest<Client> }) => void) => Plugin<Client, PluginData>;
  onRequestSuccess(callback: undefined | (data: { request: PluginRequest<Client>; response: ResponseSuccessType<any, ExtractClientAdapterType<Client extends ClientInstance ? Client<Client> : ClientInstance>> }) => void) => Plugin<Client, PluginData>;
  onRequestTrigger(callback: undefined | (data: { request: PluginRequest<Client> }) => void) => Plugin<Client, PluginData>;
  onUnmount(callback: undefined | (data: { client: Client }) => void) => Plugin<Client, PluginData>;
  trigger<Key>(method: Key, data: PluginMethodParameters<Key, Client>) => void;
}

Parameters

Name	Type	Description
config	PluginOptionsType<PluginData>

Properties

client

Source

View the source code

Type

undefined | Client

---

config

Source

View the source code

Type

PluginOptionsType<PluginData>

---

data

Source

View the source code

Type

PluginData

---

name

Source

View the source code

Type

string

---

Methods

initialize()

Source

View the source code

Preview

initialize(client: Client)

Parameters

Parameters

Name	Type	Description
client	Client

Returns

Plugin<Client, PluginData>

---

onAdapterFetch()

Source

View the source code

Preview

onAdapterFetch(callback: undefined | (data: { adapter: AdapterInstance; request: RequestInstance; requestId: string }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { adapter: AdapterInstance; request: RequestInstance; requestId: string }) => void

Returns

Plugin<Client, PluginData>

---

onCacheItemChange()

Source

View the source code

Preview

onCacheItemChange(callback: undefined | <Requests>(data: { cache: Cache<ExtractClientAdapterType<Client>>; cacheKey: Requests[cacheKey]; newData: CacheValueType<Requests[response], Requests[error], ExtractClientAdapterType<Client>>; prevData: null | CacheValueType<Requests[response], Requests[error], ExtractClientAdapterType<Client>> }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | <Requests>(data: { cache: Cache<ExtractClientAdapterType<Client>>; cacheKey: Requests[cacheKey]; newData: CacheValueType<Requests[response], Requests[error], ExtractClientAdapterType<Client>>; prevData: null | CacheValueType<Requests[response], Requests[error], ExtractClientAdapterType<Client>> }) => void

Returns

Plugin<Client, PluginData>

---

onCacheItemDelete()

Source

View the source code

Preview

onCacheItemDelete(callback: undefined | (data: { cache: Cache<ExtractClientAdapterType<Client>>; cacheKey: string }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { cache: Cache<ExtractClientAdapterType<Client>>; cacheKey: string }) => void

Returns

Plugin<Client, PluginData>

---

onDispatcherCleared()

Source

View the source code

Preview

onDispatcherCleared(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>> }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>> }) => void

Returns

Plugin<Client, PluginData>

---

onDispatcherItemAdded()

Source

View the source code

Preview

onDispatcherItemAdded(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>>; queueItem: QueueItemType<ExtendRequest<RequestInstance, { client: Client }>> }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>>; queueItem: QueueItemType<ExtendRequest<RequestInstance, { client: Client }>> }) => void

Returns

Plugin<Client, PluginData>

---

onDispatcherItemDeleted()

Source

View the source code

Preview

onDispatcherItemDeleted(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>>; queueItem: QueueItemType<ExtendRequest<RequestInstance, { client: Client }>> }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>>; queueItem: QueueItemType<ExtendRequest<RequestInstance, { client: Client }>> }) => void

Returns

Plugin<Client, PluginData>

---

onDispatcherQueueCleared()

Source

View the source code

Preview

onDispatcherQueueCleared(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>> }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>> }) => void

Returns

Plugin<Client, PluginData>

---

onDispatcherQueueCreated()

Source

View the source code

Preview

onDispatcherQueueCreated(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>> }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>> }) => void

Returns

Plugin<Client, PluginData>

---

onDispatcherQueueDrained()

Source

View the source code

Preview

onDispatcherQueueDrained(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>> }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>> }) => void

Returns

Plugin<Client, PluginData>

---

onDispatcherQueueRunning()

Source

View the source code

Preview

onDispatcherQueueRunning(callback: undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>>; status: paused | stopped | running }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { dispatcher: Dispatcher<ExtractClientAdapterType<Client>>; queue: QueueDataType<ExtendRequest<RequestInstance, { client: Client }>>; status: paused | stopped | running }) => void

Returns

Plugin<Client, PluginData>

---

onMount()

Callback that will be executed when plugin is mounted

Source

View the source code

Preview

onMount(callback: undefined | (data: { client: Client }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { client: Client }) => void

Returns

Plugin<Client, PluginData>

---

onRequestCreate()

Callback that will be executed when request is created

Source

View the source code

Preview

onRequestCreate(callback: undefined | (data: { request: PluginRequest<Client> }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { request: PluginRequest<Client> }) => void

Returns

Plugin<Client, PluginData>

---

onRequestError()

Callback that will be executed when response is failed

Source

View the source code

Preview

onRequestError(callback: undefined | (data: { request: PluginRequest<Client>; response: ResponseErrorType<any, ExtractClientAdapterType<Client extends ClientInstance ? Client<Client> : ClientInstance>> }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { request: PluginRequest<Client>; response: ResponseErrorType<any, ExtractClientAdapterType<Client extends ClientInstance ? Client<Client> : ClientInstance>> }) => void

Returns

Plugin<Client, PluginData>

---

onRequestFinished()

Callback that will be executed when response is finished

Source

View the source code

Preview

onRequestFinished(callback: undefined | (data: { request: PluginRequest<Client>; response: ResponseType<any, any, ExtractClientAdapterType<Client extends ClientInstance ? Client<Client> : ClientInstance>> }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { request: PluginRequest<Client>; response: ResponseType<any, any, ExtractClientAdapterType<Client extends ClientInstance ? Client<Client> : ClientInstance>> }) => void

Returns

Plugin<Client, PluginData>

---

onRequestStart()

Callback that will be executed when request starts

Source

View the source code

Preview

onRequestStart(callback: undefined | (data: { request: PluginRequest<Client> }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { request: PluginRequest<Client> }) => void

Returns

Plugin<Client, PluginData>

---

onRequestSuccess()

Callback that will be executed when response is successful

Source

View the source code

Preview

onRequestSuccess(callback: undefined | (data: { request: PluginRequest<Client>; response: ResponseSuccessType<any, ExtractClientAdapterType<Client extends ClientInstance ? Client<Client> : ClientInstance>> }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { request: PluginRequest<Client>; response: ResponseSuccessType<any, ExtractClientAdapterType<Client extends ClientInstance ? Client<Client> : ClientInstance>> }) => void

Returns

Plugin<Client, PluginData>

---

onRequestTrigger()

Callback that will be executed when request gets triggered

Source

View the source code

Preview

onRequestTrigger(callback: undefined | (data: { request: PluginRequest<Client> }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { request: PluginRequest<Client> }) => void

Returns

Plugin<Client, PluginData>

---

onUnmount()

Callback that will be executed when plugin is unmounted

Source

View the source code

Preview

onUnmount(callback: undefined | (data: { client: Client }) => void)

Parameters

Parameters

Name	Type	Description
callback	undefined | (data: { client: Client }) => void

Returns

Plugin<Client, PluginData>

---

trigger()

Source

View the source code

Preview

trigger<Key>(method: Key, data: PluginMethodParameters<Key, Client>)

Parameters

Parameters

Name	Type	Description
method	Key
data	PluginMethodParameters<Key, Client>

Returns

void

---