Module output

Output filter methods.

since: 3.2.0

Index

Interfaces

OutputFilterMeta

Type Aliases

OutputFilter

Functions

Type Aliases

OutputFilter

OutputFilter: ((input: string, meta: OutputFilterMeta) => boolean)

Type declaration

- (input: string, meta: OutputFilterMeta): boolean
- Parameters
  - input: string
  - meta: OutputFilterMeta
  Returns boolean

Functions

addOutputFilter

addOutputFilter(filter: OutputFilter): (() => boolean)

- Defined in vorple/output.ts:41
Registers a new output filter.

see
https://vorple-if.com/docs/filters.html

Parameters
- filter: OutputFilter
  
  The output filter to add.
Returns (() => boolean)
A function that can be called to remove the filter
- - (): boolean
  - Registers a new output filter.
    
    see
    https://vorple-if.com/docs/filters.html
    
    Returns boolean
    A function that can be called to remove the filter

applyOutputFilters

applyOutputFilters(originalOutput: string, meta: OutputFilterMeta): string

- Defined in vorple/output.ts:53
Runs output through all output filters.

internal
Parameters
- originalOutput: string
  
  The original output
- meta: OutputFilterMeta
Returns string

removeOutputFilter

removeOutputFilter(filter: OutputFilter): boolean

- Defined in vorple/output.ts:83
Removes a filter from the registered output filters.

Parameters
- filter: OutputFilter
  
  A reference to the filter to remove
Returns boolean
Returns true if the filter was removed, false if the filter wasn't registered.

Generated using TypeDoc