Skip to main content

Class: LlamaIndexCustomEvent<T>

Extends​

  • defaultCustomEvent<T>

Type parameters​

• T = any

Constructors​

new LlamaIndexCustomEvent()​

private new LlamaIndexCustomEvent<T>(event, options?): LlamaIndexCustomEvent<T>

Parameters​

• event: string

• options?: CustomEventInit<any> & object

Returns​

LlamaIndexCustomEvent<T>

Overrides​

CustomEvent<T>.constructor

Source​

packages/core/src/callbacks/CallbackManager.ts:22

Properties​

#private​

private #private: any

Inherited from​

CustomEvent.#private

Source​

packages/env/dist/type/utils.d.ts:40

AT_TARGET​

readonly AT_TARGET: 2

Inherited from​

CustomEvent.AT_TARGET

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8145

BUBBLING_PHASE​

readonly BUBBLING_PHASE: 3

Inherited from​

CustomEvent.BUBBLING_PHASE

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8146

CAPTURING_PHASE​

readonly CAPTURING_PHASE: 1

Inherited from​

CustomEvent.CAPTURING_PHASE

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8144

NONE​

readonly NONE: 0

Inherited from​

CustomEvent.NONE

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8143

bubbles​

readonly bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

MDN Reference

Inherited from​

CustomEvent.bubbles

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8040

cancelBubble​

cancelBubble: boolean

Deprecated​

MDN Reference

Inherited from​

CustomEvent.cancelBubble

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8046

cancelable​

readonly cancelable: boolean

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

MDN Reference

Inherited from​

CustomEvent.cancelable

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8052

composed​

readonly composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

MDN Reference

Inherited from​

CustomEvent.composed

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8058

currentTarget​

readonly currentTarget: null | EventTarget

Returns the object whose event listener's callback is currently being invoked.

MDN Reference

Inherited from​

CustomEvent.currentTarget

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8064

defaultPrevented​

readonly defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

MDN Reference

Inherited from​

CustomEvent.defaultPrevented

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8070

eventPhase​

readonly eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

MDN Reference

Inherited from​

CustomEvent.eventPhase

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8076

isTrusted​

readonly isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

MDN Reference

Inherited from​

CustomEvent.isTrusted

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8082

reason​

reason: null | EventCaller

Source​

packages/core/src/callbacks/CallbackManager.ts:21

returnValue​

returnValue: boolean

Deprecated​

MDN Reference

Inherited from​

CustomEvent.returnValue

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8088

srcElement​

readonly srcElement: null | EventTarget

Deprecated​

MDN Reference

Inherited from​

CustomEvent.srcElement

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8094

target​

readonly target: null | EventTarget

Returns the object to which event is dispatched (its target).

MDN Reference

Inherited from​

CustomEvent.target

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8100

timeStamp​

readonly timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

MDN Reference

Inherited from​

CustomEvent.timeStamp

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8106

type​

readonly type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

MDN Reference

Inherited from​

CustomEvent.type

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8112

AT_TARGET​

static readonly AT_TARGET: 2

Inherited from​

CustomEvent.AT_TARGET

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8154

BUBBLING_PHASE​

static readonly BUBBLING_PHASE: 3

Inherited from​

CustomEvent.BUBBLING_PHASE

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8155

CAPTURING_PHASE​

static readonly CAPTURING_PHASE: 1

Inherited from​

CustomEvent.CAPTURING_PHASE

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8153

NONE​

static readonly NONE: 0

Inherited from​

CustomEvent.NONE

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8152

Accessors​

detail​

get detail(): T

Returns​

T

Source​

packages/env/dist/type/utils.d.ts:41

Methods​

composedPath()​

composedPath(): EventTarget[]

Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

MDN Reference

Returns​

EventTarget[]

Inherited from​

CustomEvent.composedPath

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8118

initCustomEvent()​

initCustomEvent(): void

Returns​

void

Inherited from​

CustomEvent.initCustomEvent

Deprecated​

This method is not supported

Source​

packages/env/dist/type/utils.d.ts:46

initEvent()​

initEvent(type, bubbles?, cancelable?): void

Parameters​

• type: string

• bubbles?: boolean

• cancelable?: boolean

Returns​

void

Inherited from​

CustomEvent.initEvent

Deprecated​

MDN Reference

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8124

preventDefault()​

preventDefault(): void

If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

MDN Reference

Returns​

void

Inherited from​

CustomEvent.preventDefault

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8130

stopImmediatePropagation()​

stopImmediatePropagation(): void

Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

MDN Reference

Returns​

void

Inherited from​

CustomEvent.stopImmediatePropagation

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8136

stopPropagation()​

stopPropagation(): void

When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

MDN Reference

Returns​

void

Inherited from​

CustomEvent.stopPropagation

Source​

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.dom.d.ts:8142

fromEvent()​

static fromEvent<Type>(type, detail): LlamaIndexCustomEvent<any>

Type parameters​

• Type extends keyof LlamaIndexEventMaps

Parameters​

• type: Type

• detail: LlamaIndexEventMaps[Type]["detail"]

Returns​

LlamaIndexCustomEvent<any>

Source​

packages/core/src/callbacks/CallbackManager.ts:32