Class FeedEmitter

Hierarchy

TinyEmitter
- FeedEmitter

Index

Constructors

constructor

Methods

Constructors

constructor

new FeedEmitter(options?: Options): FeedEmitter

- Defined in lib/index.ts:66
Initialize the rss feed emitter

Parameters
- Default value options: Options = {}
Returns FeedEmitter

Methods

add

add(feedConfig: FeedConfig): FeedConfig[]

- Defined in lib/index.ts:86
Add a new feed to the feed list

Parameters
- feedConfig: FeedConfig
Returns FeedConfig[]

destroy

destroy(): void

- Defined in lib/index.ts:118
Remove all feeds

Returns void

emit

emit(event: string, ...args: any[]): this

Inherited from FeedEmitter.emit
- Defined in node_modules/tiny-emitter/index.d.ts:4
Parameters
- event: string
- Rest ...args: any[]
Returns this

get

get(url: string): FeedConfig | undefined

- Defined in lib/index.ts:96
Get specific feed from the feedlist

Parameters
- url: string
Returns FeedConfig | undefined

list

list(): FeedConfig[]

- Defined in lib/index.ts:113
List all feeds

Returns FeedConfig[]

off

off(event: string, callback?: Function): this

Inherited from FeedEmitter.off
- Defined in node_modules/tiny-emitter/index.d.ts:5
Parameters
- event: string
- Optional callback: Function
Returns this

on

on(event: string, callback: Function, ctx?: any): this

Inherited from FeedEmitter.on
- Defined in node_modules/tiny-emitter/index.d.ts:2
Parameters
- event: string
- callback: Function
- Optional ctx: any
Returns this

once

once(event: string, callback: Function, ctx?: any): this

Inherited from FeedEmitter.once
- Defined in node_modules/tiny-emitter/index.d.ts:3
Parameters
- event: string
- callback: Function
- Optional ctx: any
Returns this

remove

remove(url: string): void

- Defined in lib/index.ts:104
Remove a feed from the feed list

Parameters
- url: string
Returns void

Generated using TypeDoc