aisbreaker-api-js - v0.1.15 / services/filters/MirrorFilter / MirrorFilter

Class: MirrorFilter

services/filters/MirrorFilter.MirrorFilter

Every service API must implement this interface.

Hierarchy

• BaseAIsFilter<FilterProps>

  ↳ MirrorFilter

Table of contents

Constructors

• constructor

Properties

• auth
• serviceProps

Methods

• getForward2Service
• getMirroredServiceId
• getMirroredStreamProgressFunction
• getMirroredUsage
• mirrorOutputs
• mirrorString
• process

Constructors

constructor

• new MirrorFilter(serviceProps, auth?)

Parameters

Name	Type
serviceProps	FilterProps
auth?	Auth

Overrides

BaseAIsFilter.constructor

Defined in

aisbreaker-js/packages/aisbreaker-api-js/src/services/filters/MirrorFilter.ts:14

Properties

auth

• Optional auth: Auth

Inherited from

BaseAIsFilter.auth

Defined in

aisbreaker-js/packages/aisbreaker-api-js/src/base/BaseAIsFilter.ts:24

---

serviceProps

• serviceProps: FilterProps

set in constructor

Inherited from

BaseAIsFilter.serviceProps

Defined in

aisbreaker-js/packages/aisbreaker-api-js/src/base/BaseAIsFilter.ts:23

Methods

getForward2Service

▸ getForward2Service(): AIsService

Returns

AIsService

Inherited from

BaseAIsFilter.getForward2Service

Defined in

aisbreaker-js/packages/aisbreaker-api-js/src/base/BaseAIsFilter.ts:33

---

getMirroredServiceId

▸ Protected getMirroredServiceId(origServiceId): string

Parameters

Name	Type
origServiceId	string

Returns

string

Defined in

aisbreaker-js/packages/aisbreaker-api-js/src/services/filters/MirrorFilter.ts:115

---

getMirroredStreamProgressFunction

▸ Protected getMirroredStreamProgressFunction(origFunc?): undefined | StreamProgressFunction

Parameters

Name	Type
origFunc?	StreamProgressFunction

Returns

undefined | StreamProgressFunction

Defined in

aisbreaker-js/packages/aisbreaker-api-js/src/services/filters/MirrorFilter.ts:86

---

getMirroredUsage

▸ Protected getMirroredUsage(origUsage): Usage

Parameters

Name	Type
origUsage	Usage

Returns

Usage

Defined in

aisbreaker-js/packages/aisbreaker-api-js/src/services/filters/MirrorFilter.ts:107

---

mirrorOutputs

▸ Protected mirrorOutputs(origOutputs): Output[]

Parameters

Name	Type
origOutputs	Output[]

Returns

Output[]

Defined in

aisbreaker-js/packages/aisbreaker-api-js/src/services/filters/MirrorFilter.ts:48

---

mirrorString

▸ Protected mirrorString(s): string

Parameters

Name	Type
s	string

Returns

string

Defined in

aisbreaker-js/packages/aisbreaker-api-js/src/services/filters/MirrorFilter.ts:81

---

process

▸ process(request): Promise<ResponseFinal>

Let the service do its work.

Alternative names: infer, derive, task, reply, respond, process, ...

Parameters

Name	Type
request	Request

Returns

Promise<ResponseFinal>

Overrides

BaseAIsFilter.process

Defined in

aisbreaker-js/packages/aisbreaker-api-js/src/services/filters/MirrorFilter.ts:18