// Emit an event on the core
cy.emit(events: string | EventProps, extraParams?: unknown[]): thisEmit an event on the core.
Custom event names are supported API, which is why on() validates none: cy.emit( 'myevent') runs handlers registered for 'myevent', and the same holds on elements. Names the library itself never emits are therefore legal to register and simply never fire — see on() for which those are.
| Name | Description |
|---|---|
events: string | EventProps | one or more space-separated event names, or an event props object |
extraParams: unknown[]? | extra arguments passed to each handler after the event object |
Fields of events
| Name | Description |
|---|---|
type: string? | |
target: EventTarget? | |
cy: Core? | |
position: Position? | model-space position, for pointer-derived events |
renderedPosition: Position? | rendered-space position; derived from |
originalEvent: NativeEvent? | the DOM event behind a gesture |
layout: unknown? | the layout instance, on |
cancelled: boolean? | on |
diff: PatchDiff? | on |
progress: LoadProgress? | on |
timeStamp: number? |
thisthis core, for chaining
Example
let observed;cy.one('example', event => { observed = event.type; });cy.emit('example');console.log(observed); // 'example'Also spelled cy.trigger.