Class: LlamaIndexCustomEvent<T>
Type parameters
| Name | Type |
|---|---|
T | any |
Hierarchy
-
defaultCustomEvent<T>↳
LlamaIndexCustomEvent
Constructors
constructor
• new LlamaIndexCustomEvent<T>(event, options?): LlamaIndexCustomEvent<T>
Type parameters
| Name | Type |
|---|---|
T | any |
Parameters
| Name | Type |
|---|---|
event | string |
options? | CustomEventInit<any> & { reason?: null | EventCaller } |
Returns
Overrides
CustomEvent<T>.constructor
Defined in
packages/core/src/callbacks/CallbackManager.ts:11
Properties
AT_TARGET
• Readonly AT_TARGET: 2
Inherited from
CustomEvent.AT_TARGET
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:8145
BUBBLING_PHASE
• Readonly BUBBLING_PHASE: 3
Inherited from
CustomEvent.BUBBLING_PHASE
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:8146
CAPTURING_PHASE
• Readonly CAPTURING_PHASE: 1
Inherited from
CustomEvent.CAPTURING_PHASE
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:8144
NONE
• Readonly NONE: 0
Inherited from
CustomEvent.NONE
Defined in
node_modules/.pnpm/typescript@5.4.3/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.
Inherited from
CustomEvent.bubbles
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:8040
cancelBubble
• cancelBubble: boolean
Deprecated
Inherited from
CustomEvent.cancelBubble
Defined in
node_modules/.pnpm/typescript@5.4.3/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.
Inherited from
CustomEvent.cancelable
Defined in
node_modules/.pnpm/typescript@5.4.3/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.
Inherited from
CustomEvent.composed
Defined in
node_modules/.pnpm/typescript@5.4.3/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.
Inherited from
CustomEvent.currentTarget
Defined in
node_modules/.pnpm/typescript@5.4.3/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.
Inherited from
CustomEvent.defaultPrevented
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:8070
detail
• Readonly detail: T
Returns any custom data event was created with. Typically used for synthetic events.
Inherited from
CustomEvent.detail
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:5959
eventPhase
• Readonly eventPhase: number
Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.
Inherited from
CustomEvent.eventPhase
Defined in
node_modules/.pnpm/typescript@5.4.3/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.
Inherited from
CustomEvent.isTrusted
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:8082
reason
• reason: null | EventCaller
Defined in
packages/core/src/callbacks/CallbackManager.ts:10
returnValue
• returnValue: boolean
Deprecated
Inherited from
CustomEvent.returnValue
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:8088
srcElement
• Readonly srcElement: null | EventTarget
Deprecated
Inherited from
CustomEvent.srcElement
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:8094
target
• Readonly target: null | EventTarget
Returns the object to which event is dispatched (its target).
Inherited from
CustomEvent.target
Defined in
node_modules/.pnpm/typescript@5.4.3/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.
Inherited from
CustomEvent.timeStamp
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:8106
type
• Readonly type: string
Returns the type of event, e.g. "click", "hashchange", or "submit".
Inherited from
CustomEvent.type
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:8112
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.
Returns
EventTarget[]
Inherited from
CustomEvent.composedPath
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:8118
initCustomEvent
▸ initCustomEvent(type, bubbles?, cancelable?, detail?): void
Parameters
| Name | Type |
|---|---|
type | string |
bubbles? | boolean |
cancelable? | boolean |
detail? | T |
Returns
void
Deprecated
Inherited from
CustomEvent.initCustomEvent
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:5965
initEvent
▸ initEvent(type, bubbles?, cancelable?): void
Parameters
| Name | Type |
|---|---|
type | string |
bubbles? | boolean |
cancelable? | boolean |
Returns
void
Deprecated
Inherited from
CustomEvent.initEvent
Defined in
node_modules/.pnpm/typescript@5.4.3/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.
Returns
void
Inherited from
CustomEvent.preventDefault
Defined in
node_modules/.pnpm/typescript@5.4.3/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.
Returns
void
Inherited from
CustomEvent.stopImmediatePropagation
Defined in
node_modules/.pnpm/typescript@5.4.3/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.
Returns
void
Inherited from
CustomEvent.stopPropagation
Defined in
node_modules/.pnpm/typescript@5.4.3/node_modules/typescript/lib/lib.dom.d.ts:8142
fromEvent
▸ fromEvent<Type>(type, detail): LlamaIndexCustomEvent<any>
Type parameters
| Name | Type |
|---|---|
Type | extends keyof LlamaIndexEventMaps |
Parameters
| Name | Type |
|---|---|
type | Type |
detail | LlamaIndexEventMaps[Type]["detail"] |