Class Typeahead<T>

The Typeahead class is a state and options holder for the typeahead function.

Aracna Reference

Type Parameters

Hierarchy (View Summary)

EventEmitter<TypeaheadEvents<T>>
- Typeahead

Constructors

constructor

new Typeahead<T>(
    key: TypeaheadMapKey,
    items?: T[],
    predicate?: TypeaheadPredicate<T>,
    debounceTime?: number,
): Typeahead<T>
Type Parameters
- T
Parameters
- key: TypeaheadMapKey
- items: T[] = []
- predicate: TypeaheadPredicate<T> = noop
- debounceTime: number = DEFAULT_TYPEAHEAD_DEBOUNCE_TIME
Returns Typeahead<T>
Overrides EventEmitter.constructor
- Defined in src/classes/typeahead.ts:36

Properties

`Protected`chunks

chunks: string[]

The chunks that make up the query string.

`Protected`debounceTime

debounceTime: number

The debounce time.

`Protected`items

items: T[]

The items to search.

`Protected` `Readonly`key

key: TypeaheadMapKey

The key of the instance.

`Protected`listeners

listeners: EventEmitterListener<TypeaheadEvents<T>, keyof TypeaheadEvents<T>>[]

`Protected`maxListeners

maxListeners: number

`Protected`predicate

predicate: TypeaheadPredicate<T>

The predicate function.

Methods

countListeners

countListeners<K extends keyof TypeaheadEvents<T>>(
    name?: K,
    callback?: TypeaheadEvents<T>[K],
    options?: EventEmitterListenerOptions,
): number
Counts the listeners that match the name, callback and options. If no arguments are passed, all listeners will be counted.
Type Parameters
- K extends keyof TypeaheadEvents<T>
Parameters
- Optionalname: K
- Optionalcallback: TypeaheadEvents<T>[K]
- Optionaloptions: EventEmitterListenerOptions
Returns number
Inherited from EventEmitter.countListeners
- Defined in src/classes/event-emitter.ts:27

`Protected`debouncefn

debouncefn(): void
The debounce function.

Returns void
- Defined in src/classes/typeahead.ts:49

emit

emit<K extends keyof TypeaheadEvents<T>>(
name: K,
...args: Parameters<TypeaheadEvents<T>[K]>,
): boolean
Emits an event.
Type Parameters
- K extends keyof TypeaheadEvents<T>
Parameters
- name: K
- ...args: Parameters<TypeaheadEvents<T>[K]>
Returns boolean
Inherited from EventEmitter.emit
- Defined in src/classes/event-emitter.ts:34

getDebounceTime

getDebounceTime(): number
Returns the debounce time.

Returns number
- Defined in src/classes/typeahead.ts:73

getEventNames

getEventNames(): (keyof TypeaheadEvents<T>)[]
Returns the names of the events that have listeners.

Returns (keyof TypeaheadEvents<T>)[]
Inherited from EventEmitter.getEventNames
- Defined in src/classes/event-emitter.ts:56

getItems

getItems(): T[]
Returns the items.

Returns T[]
- Defined in src/classes/typeahead.ts:80

getKey

getKey(): TypeaheadMapKey
Returns the key of the instance.

Returns TypeaheadMapKey
- Defined in src/classes/typeahead.ts:87

getListeners

getListeners<K extends keyof TypeaheadEvents<T>>(
    name?: K,
    callback?: TypeaheadEvents<T>[K],
    options?: EventEmitterListenerOptions,
): EventEmitterListener<TypeaheadEvents<T>, keyof TypeaheadEvents<T>>[]
Returns the listeners that match the name, callback and options. If no arguments are passed, all listeners will be returned.
Type Parameters
- K extends keyof TypeaheadEvents<T>
Parameters
- Optionalname: K
- Optionalcallback: TypeaheadEvents<T>[K]
- Optionaloptions: EventEmitterListenerOptions
Returns EventEmitterListener<TypeaheadEvents<T>, keyof TypeaheadEvents<T>>[]
Inherited from EventEmitter.getListeners
- Defined in src/classes/event-emitter.ts:64

getMaxListeners

getMaxListeners(): number
Returns the maximum number of listeners that can be registered for a single event.

Returns number
Inherited from EventEmitter.getMaxListeners
- Defined in src/classes/event-emitter.ts:78

getPredicate

getPredicate(): TypeaheadPredicate<T>
Returns the predicate function.

Returns TypeaheadPredicate<T>
- Defined in src/classes/typeahead.ts:94

getQuery

getQuery(): string
Returns the query string.

Returns string
- Defined in src/classes/typeahead.ts:101

hasListeners

hasListeners<K extends keyof TypeaheadEvents<T>>(
    name?: K,
    callback?: TypeaheadEvents<T>[K],
    options?: EventEmitterListenerOptions,
): boolean
Checks if the event has listeners that match the name, callback and options.
Type Parameters
- K extends keyof TypeaheadEvents<T>
Parameters
- Optionalname: K
- Optionalcallback: TypeaheadEvents<T>[K]
- Optionaloptions: EventEmitterListenerOptions
Returns boolean
Inherited from EventEmitter.hasListeners
- Defined in src/classes/event-emitter.ts:85

off

off<K extends keyof TypeaheadEvents<T>>(
    name?: K,
    callback?: TypeaheadEvents<T>[K],
    options?: EventEmitterListenerOptions,
): this
Removes the listeners that match the name, callback and options. If no arguments are passed, all listeners will be removed.
Type Parameters
- K extends keyof TypeaheadEvents<T>
Parameters
- Optionalname: K
- Optionalcallback: TypeaheadEvents<T>[K]
- Optionaloptions: EventEmitterListenerOptions
Returns this
Inherited from EventEmitter.off
- Defined in src/classes/event-emitter.ts:93

on

on<K extends keyof TypeaheadEvents<T>>(
    name: K,
    callback: TypeaheadEvents<T>[K],
    options?: EventEmitterListenerOptions,
): this
Adds a listener, which will be called when the event is emitted.

Optionally the listener can be removed after the first call with the once option. Optionally the listener can be prepended to the listeners array with the prepend option.
Type Parameters
- K extends keyof TypeaheadEvents<T>
Parameters
- name: K
- callback: TypeaheadEvents<T>[K]
- Optionaloptions: EventEmitterListenerOptions
Returns this
Inherited from EventEmitter.on
- Defined in src/classes/event-emitter.ts:113

once

once<K extends keyof TypeaheadEvents<T>>(
    name: K,
    callback: TypeaheadEvents<T>[K],
    options?: EventEmitterListenerOptions,
): this
Adds a listener, which will be called only once when the event is emitted.
Type Parameters
- K extends keyof TypeaheadEvents<T>
Parameters
- name: K
- callback: TypeaheadEvents<T>[K]
- Optionaloptions: EventEmitterListenerOptions
Returns this
Inherited from EventEmitter.once
- Defined in src/classes/event-emitter.ts:140

prepend

prepend<K extends keyof TypeaheadEvents<T>>(
    name: K,
    callback: TypeaheadEvents<T>[K],
    options?: EventEmitterListenerOptions,
): this
Adds a listener, which will be called first when the event is emitted.
Type Parameters
- K extends keyof TypeaheadEvents<T>
Parameters
- name: K
- callback: TypeaheadEvents<T>[K]
- Optionaloptions: EventEmitterListenerOptions
Returns this
Inherited from EventEmitter.prepend
- Defined in src/classes/event-emitter.ts:147

pushChunks

pushChunks(...chunks: string[]): this
Pushes chunks to the chunks array.
Parameters
- ...chunks: string[]
Returns this
- Defined in src/classes/typeahead.ts:108

search

search(): this
Searches the items for a match and emits the match event if a match is found.

Returns this
- Defined in src/classes/typeahead.ts:63

setChunks

setChunks(chunks: string[] | undefined): this
Sets the chunks.
Parameters
- chunks: string[] | undefined
Returns this
- Defined in src/classes/typeahead.ts:132

setDebounceTime

setDebounceTime(debounceTime: number | undefined): this
Sets the debounce time.
Parameters
- debounceTime: number | undefined
Returns this
- Defined in src/classes/typeahead.ts:116

setItems

setItems(items: T[] | undefined): this
Sets the items.
Parameters
- items: T[] | undefined
Returns this
- Defined in src/classes/typeahead.ts:124

setListeners

setListeners(
    listeners: EventEmitterListener<
        TypeaheadEvents<T>,
        keyof TypeaheadEvents<T>,
    >[],
): this
Sets the listeners.
Parameters
- listeners: EventEmitterListener<TypeaheadEvents<T>, keyof TypeaheadEvents<T>>[]
Returns this
Inherited from EventEmitter.setListeners
- Defined in src/classes/event-emitter.ts:154

setMaxListeners

setMaxListeners(n: number): this
Sets the maximum number of listeners that can be registered for a single event.
Parameters
- n: number
Returns this
Inherited from EventEmitter.setMaxListeners
- Defined in src/classes/event-emitter.ts:164

setPredicate

setPredicate(predicate: TypeaheadPredicate<T> | undefined): this
Sets the predicate function.
Parameters
- predicate: TypeaheadPredicate<T> | undefined
Returns this
- Defined in src/classes/typeahead.ts:140

Class Typeahead<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Typeahead<T>

Properties

Protectedchunks

ProtecteddebounceTime

Protecteditems

Protected Readonlykey

Protectedlisteners

ProtectedmaxListeners

Protectedpredicate

Methods

countListeners

Type Parameters

Parameters

Returns number

Protecteddebouncefn

Returns void

emit

Type Parameters

Parameters

Returns boolean

getDebounceTime

Returns number

getEventNames

Returns (keyof TypeaheadEvents<T>)[]

getItems

Returns T[]

getKey

Returns TypeaheadMapKey

getListeners

Type Parameters

Parameters

Returns EventEmitterListener<TypeaheadEvents<T>, keyof TypeaheadEvents<T>>[]

getMaxListeners

Returns number

getPredicate

Returns TypeaheadPredicate<T>

getQuery

Returns string

hasListeners

Type Parameters

Parameters

Returns boolean

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

prepend

Type Parameters

Parameters

Returns this

pushChunks

Parameters

Returns this

search

Returns this

setChunks

Parameters

Returns this

setDebounceTime

Parameters

Returns this

`Protected`chunks

`Protected`debounceTime

`Protected`items

`Protected` `Readonly`key

`Protected`listeners

`Protected`maxListeners

`Protected`predicate

`Protected`debouncefn