Skip to content

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

Interface: FilterProps ​

base/BaseAIsFilter.FilterProps

Every AIsService can be parameterized with these or (in very rare cases) with a service-specific extention of these properties.

Hierarchy ​

Table of contents ​

Properties ​

Properties ​

forward2Service ​

• Optional forward2Service: AIsService

The actual service instance; this filter will forward to this service. Either forward2ServiceProps or forward2Service must be set.

Defined in ​

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


forward2ServiceProps ​

• Optional forward2ServiceProps: AIsServiceProps

The actual service; this filter will forward to this service. Either forward2ServiceProps or forward2Service must be set.

Defined in ​

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


internServiceOptions ​

• Optional internServiceOptions: any

Service implementation specific opts. Try to avoid using them because they are NOT portable!!!

Inherited from ​

AIsServiceProps.internServiceOptions

Defined in ​

aisbreaker-js/packages/aisbreaker-api-js/src/api/AIsService.ts:42


serviceId ​

• serviceId: string

Unique identified of the AIsBreaker service, see: https://aisbreaker.org/docs/serviceId

Inherited from ​

AIsServiceProps.serviceId

Defined in ​

aisbreaker-js/packages/aisbreaker-api-js/src/api/AIsService.ts:31


url ​

• Optional url: string

URL of the AI service (optional).

Inherited from ​

AIsServiceProps.url

Defined in ​

aisbreaker-js/packages/aisbreaker-api-js/src/api/AIsService.ts:36

Released under the MIT License.