aisbreaker-api-js - v0.1.15 / base/BaseAIsFilter / BaseAIsFilter

Class: BaseAIsFilter<PROPS_T>

base/BaseAIsFilter.BaseAIsFilter

Every service API must implement this interface.

Type parameters

Name	Type
PROPS_T	extends FilterProps

Hierarchy

• BaseAIsFilter

  ↳ LoggingFilter

  ↳ MirrorFilter

  ↳ NopFilter

  ↳ NormalizeFilter

Implements

• AIsService

Table of contents

Constructors

• constructor

Properties

• auth
• serviceProps

Methods

• getForward2Service
• process

Constructors

constructor

• new BaseAIsFilter<PROPS_T>(serviceProps, auth?)

Type parameters

Name	Type
PROPS_T	extends FilterProps

Parameters

Name	Type
serviceProps	PROPS_T
auth?	Auth

Defined in

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

Properties

auth

• Optional auth: Auth

Defined in

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

---

serviceProps

• serviceProps: PROPS_T

set in constructor

Implementation of

AIsService.serviceProps

Defined in

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

Methods

getForward2Service

▸ getForward2Service(): AIsService

Returns

AIsService

Defined in

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

---

process

▸ Abstract 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>

Implementation of

AIsService.process

Defined in

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