Options
All
  • Public
  • Public/Protected
  • All
Menu

Plan Engine

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AlgorithmIdentifier

AlgorithmIdentifier: string | Algorithm

AlignSetting

AlignSetting: "start" | "center" | "end" | "left" | "right"

AnimationPlayState

AnimationPlayState: "idle" | "running" | "paused" | "finished"

AppendMode

AppendMode: "segments" | "sequence"

ArrayBufferLike

ArrayBufferLike: ArrayBuffer

AudioContextLatencyCategory

AudioContextLatencyCategory: "balanced" | "interactive" | "playback"

AudioContextState

AudioContextState: "suspended" | "running" | "closed"

AutoKeyword

AutoKeyword: "auto"

AutomationRate

AutomationRate: "a-rate" | "k-rate"

BigInteger

BigInteger: Uint8Array

BinaryType

BinaryType: "blob" | "arraybuffer"

BiquadFilterType

BiquadFilterType: "lowpass" | "highpass" | "bandpass" | "lowshelf" | "highshelf" | "peaking" | "notch" | "allpass"

BlobPart

BlobPart: BufferSource | Blob | string

BodyInit

BodyInit: Blob | BufferSource | FormData | URLSearchParams | ReadableStream<Uint8Array> | string

BufferSource

BufferSource: ArrayBufferView | ArrayBuffer

CanPlayTypeResult

CanPlayTypeResult: "" | "maybe" | "probably"

CanvasDirection

CanvasDirection: "ltr" | "rtl" | "inherit"

CanvasFillRule

CanvasFillRule: "nonzero" | "evenodd"

CanvasImageSource

CanvasImageSource: HTMLOrSVGImageElement | HTMLVideoElement | HTMLCanvasElement | ImageBitmap

CanvasLineCap

CanvasLineCap: "butt" | "round" | "square"

CanvasLineJoin

CanvasLineJoin: "round" | "bevel" | "miter"

CanvasTextAlign

CanvasTextAlign: "start" | "end" | "left" | "right" | "center"

CanvasTextBaseline

CanvasTextBaseline: "top" | "hanging" | "middle" | "alphabetic" | "ideographic" | "bottom"

ChannelCountMode

ChannelCountMode: "max" | "clamped-max" | "explicit"

ChannelInterpretation

ChannelInterpretation: "speakers" | "discrete"

ClassDecorator

ClassDecorator: function

Type declaration

    • <TFunction>(target: TFunction): TFunction | void

    • Type parameters

      • TFunction: Function

      Parameters

      • target: TFunction

      Returns TFunction | void

ClientTypes

ClientTypes: "window" | "worker" | "sharedworker" | "all"

CompositeOperation

CompositeOperation: "replace" | "add" | "accumulate"

CompositeOperationOrAuto

CompositeOperationOrAuto: "replace" | "add" | "accumulate" | "auto"

ConstrainBoolean

ConstrainBoolean: boolean | ConstrainBooleanParameters

ConstrainDOMString

ConstrainDOMString: string | string[] | ConstrainDOMStringParameters

ConstrainDouble

ConstrainDouble: number | ConstrainDoubleRange

ConstrainLong

ConstrainLong: number | ConstrainLongRange

ConstructorParameters

ConstructorParameters: ConstructorParameters<T>

Obtain the parameters of a constructor function type in a tuple

DOMHighResTimeStamp

DOMHighResTimeStamp: number

DOMTimeStamp

DOMTimeStamp: number

DirectionSetting

DirectionSetting: "" | "rl" | "lr"

DisplayCaptureSurfaceType

DisplayCaptureSurfaceType: "monitor" | "window" | "application" | "browser"

DistanceModelType

DistanceModelType: "linear" | "inverse" | "exponential"

DocumentReadyState

DocumentReadyState: "loading" | "interactive" | "complete"

EffectiveWhenOperator

EffectiveWhenOperator: "exists" | "=" | "!=" | ">" | "<" | ">=" | "<="

All possible values of effectiveWhen.operator

EndOfStreamError

EndOfStreamError: "network" | "decode"

EndingType

EndingType: "transparent" | "native"

EventListenerOrEventListenerObject

EventListenerOrEventListenerObject: EventListener | EventListenerObject

Exclude

Exclude: Exclude<T, U>

Exclude from T those types that are assignable to U

Extract

Extract: Extract<T, U>

Extract from T those types that are assignable to U

FillMode

FillMode: "none" | "forwards" | "backwards" | "both" | "auto"

Float32List

Float32List: Float32Array | GLfloat[]

FormDataEntryValue

FormDataEntryValue: File | string

GLbitfield

GLbitfield: number

GLboolean

GLboolean: boolean

GLclampf

GLclampf: number

GLenum

GLenum: number

GLfloat

GLfloat: number

GLint

GLint: number

GLintptr

GLintptr: number

GLsizei

GLsizei: number

GLsizeiptr

GLsizeiptr: number

GLuint

GLuint: number

GamepadHand

GamepadHand: "" | "left" | "right"

GamepadHapticActuatorType

GamepadHapticActuatorType: "vibration"

GamepadInputEmulationType

GamepadInputEmulationType: "mouse" | "keyboard" | "gamepad"

GamepadMappingType

GamepadMappingType: "" | "standard"

HTMLOrSVGImageElement

HTMLOrSVGImageElement: HTMLImageElement | SVGImageElement

HTMLOrSVGScriptElement

HTMLOrSVGScriptElement: HTMLScriptElement | SVGScriptElement

HashAlgorithmIdentifier

HashAlgorithmIdentifier: AlgorithmIdentifier

HeadersInit

HeadersInit: Headers | string[][] | Record<string, string>

IDBCursorDirection

IDBCursorDirection: "next" | "nextunique" | "prev" | "prevunique"

IDBKeyPath

IDBKeyPath: string

IDBRequestReadyState

IDBRequestReadyState: "pending" | "done"

IDBTransactionMode

IDBTransactionMode: "readonly" | "readwrite" | "versionchange"

IDBValidKey

IDBValidKey: number | string | Date | BufferSource | IDBArrayKey

ImageBitmapSource

ImageBitmapSource: CanvasImageSource | Blob | ImageData

ImageSmoothingQuality

ImageSmoothingQuality: "low" | "medium" | "high"

InsertPosition

InsertPosition: "beforebegin" | "afterbegin" | "beforeend" | "afterend"

InstanceType

InstanceType: InstanceType<T>

Obtain the return type of a constructor function type

Int32List

Int32List: Int32Array | GLint[]

IterationCompositeOperation

IterationCompositeOperation: "replace" | "accumulate"

KeyFormat

KeyFormat: "raw" | "spki" | "pkcs8" | "jwk"

KeyType

KeyType: "public" | "private" | "secret"

KeyUsage

KeyUsage: "encrypt" | "decrypt" | "sign" | "verify" | "deriveKey" | "deriveBits" | "wrapKey" | "unwrapKey"

LineAlignSetting

LineAlignSetting: "start" | "center" | "end"

LineAndPositionSetting

LineAndPositionSetting: number | AutoKeyword

ListeningState

ListeningState: "inactive" | "active" | "disambiguation"

MSCredentialType

MSCredentialType: "FIDO_2_0"

MSTransportType

MSTransportType: "Embedded" | "USB" | "NFC" | "BT"

MSWebViewPermissionState

MSWebViewPermissionState: "unknown" | "defer" | "allow" | "deny"

MSWebViewPermissionType

MSWebViewPermissionType: "geolocation" | "unlimitedIndexedDBQuota" | "media" | "pointerlock" | "webnotifications"

MediaDeviceKind

MediaDeviceKind: "audioinput" | "audiooutput" | "videoinput"

MediaKeyMessageType

MediaKeyMessageType: "license-request" | "license-renewal" | "license-release" | "individualization-request"

MediaKeySessionType

MediaKeySessionType: "temporary" | "persistent-license" | "persistent-release-message"

MediaKeyStatus

MediaKeyStatus: "usable" | "expired" | "output-downscaled" | "output-not-allowed" | "status-pending" | "internal-error"

MediaKeysRequirement

MediaKeysRequirement: "required" | "optional" | "not-allowed"

MediaStreamTrackState

MediaStreamTrackState: "live" | "ended"

MessageEventSource

MessageEventSource: WindowProxy | MessagePort | ServiceWorker

MethodDecorator

MethodDecorator: function

Type declaration

MochaDone

MochaDone: Done
deprecated

use Mocha.Done instead.

MouseWheelEvent

MouseWheelEvent: WheelEvent
deprecated

MutationRecordType

MutationRecordType: "attributes" | "characterData" | "childList"

NamedCurve

NamedCurve: string

NavigationReason

NavigationReason: "up" | "down" | "left" | "right"

NavigationType

NavigationType: "navigate" | "reload" | "back_forward" | "prerender"

NonNullable

NonNullable: NonNullable<T>

Exclude null and undefined from T

NotificationDirection

NotificationDirection: "auto" | "ltr" | "rtl"

NotificationPermission

NotificationPermission: "default" | "denied" | "granted"

OnBeforeUnloadEventHandler

OnBeforeUnloadEventHandler: OnBeforeUnloadEventHandlerNonNull | null

OnErrorEventHandler

OnErrorEventHandler: OnErrorEventHandlerNonNull | null

OrientationLockType

OrientationLockType: "any" | "natural" | "landscape" | "portrait" | "portrait-primary" | "portrait-secondary" | "landscape-primary" | "landscape-secondary"

OrientationType

OrientationType: "portrait-primary" | "portrait-secondary" | "landscape-primary" | "landscape-secondary"

OscillatorType

OscillatorType: "sine" | "square" | "sawtooth" | "triangle" | "custom"

OverSampleType

OverSampleType: "none" | "2x" | "4x"

PanningModelType

PanningModelType: "equalpower" | "HRTF"

ParameterDecorator

ParameterDecorator: function

Type declaration

    • (target: Object, propertyKey: string | symbol, parameterIndex: number): void

    • Parameters

      • target: Object
      • propertyKey: string | symbol
      • parameterIndex: number

      Returns void

Parameters

Parameters: Parameters<T>

Obtain the parameters of a function type in a tuple

Partial

Partial: object

Make all properties in T optional

Type declaration

PaymentComplete

PaymentComplete: "success" | "fail" | "unknown"

PaymentShippingType

PaymentShippingType: "shipping" | "delivery" | "pickup"

PerformanceEntryList

PerformanceEntryList: PerformanceEntry[]

Pick

Pick: object

From T, pick a set of properties whose keys are in the union K

Type declaration

PlaybackDirection

PlaybackDirection: "normal" | "reverse" | "alternate" | "alternate-reverse"

PositionAlignSetting

PositionAlignSetting: "line-left" | "center" | "line-right" | "auto"

PromiseConstructorLike

PromiseConstructorLike: object

Type declaration

PropertyDecorator

PropertyDecorator: function

Type declaration

    • (target: Object, propertyKey: string | symbol): void

    • Parameters

      • target: Object
      • propertyKey: string | symbol

      Returns void

PropertyKey

PropertyKey: string | number | symbol

PushEncryptionKeyName

PushEncryptionKeyName: "p256dh" | "auth"

PushPermissionState

PushPermissionState: "denied" | "granted" | "prompt"

RTCBundlePolicy

RTCBundlePolicy: "balanced" | "max-compat" | "max-bundle"

RTCDataChannelState

RTCDataChannelState: "connecting" | "open" | "closing" | "closed"

RTCDegradationPreference

RTCDegradationPreference: "maintain-framerate" | "maintain-resolution" | "balanced"

RTCDtlsRole

RTCDtlsRole: "auto" | "client" | "server"

RTCDtlsTransportState

RTCDtlsTransportState: "new" | "connecting" | "connected" | "closed" | "failed"

RTCDtxStatus

RTCDtxStatus: "disabled" | "enabled"

RTCErrorDetailType

RTCErrorDetailType: "data-channel-failure" | "dtls-failure" | "fingerprint-failure" | "idp-bad-script-failure" | "idp-execution-failure" | "idp-load-failure" | "idp-need-login" | "idp-timeout" | "idp-tls-failure" | "idp-token-expired" | "idp-token-invalid" | "sctp-failure" | "sdp-syntax-error" | "hardware-encoder-not-available" | "hardware-encoder-error"

RTCIceCandidateType

RTCIceCandidateType: "host" | "srflx" | "prflx" | "relay"

RTCIceComponent

RTCIceComponent: "rtp" | "rtcp"

RTCIceConnectionState

RTCIceConnectionState: "new" | "checking" | "connected" | "completed" | "disconnected" | "failed" | "closed"

RTCIceCredentialType

RTCIceCredentialType: "password" | "oauth"

RTCIceGatherCandidate

RTCIceGatherCandidate: RTCIceCandidateDictionary | RTCIceCandidateComplete

RTCIceGatherPolicy

RTCIceGatherPolicy: "all" | "nohost" | "relay"

RTCIceGathererState

RTCIceGathererState: "new" | "gathering" | "complete"

RTCIceGatheringState

RTCIceGatheringState: "new" | "gathering" | "complete"

RTCIceProtocol

RTCIceProtocol: "udp" | "tcp"

RTCIceRole

RTCIceRole: "controlling" | "controlled"

RTCIceTcpCandidateType

RTCIceTcpCandidateType: "active" | "passive" | "so"

RTCIceTransportPolicy

RTCIceTransportPolicy: "relay" | "all"

RTCIceTransportState

RTCIceTransportState: "new" | "checking" | "connected" | "completed" | "disconnected" | "failed" | "closed"

RTCPeerConnectionState

RTCPeerConnectionState: "new" | "connecting" | "connected" | "disconnected" | "failed" | "closed"

RTCPriorityType

RTCPriorityType: "very-low" | "low" | "medium" | "high"

RTCRtcpMuxPolicy

RTCRtcpMuxPolicy: "negotiate" | "require"

RTCRtpTransceiverDirection

RTCRtpTransceiverDirection: "sendrecv" | "sendonly" | "recvonly" | "inactive"

RTCSctpTransportState

RTCSctpTransportState: "connecting" | "connected" | "closed"

RTCSdpType

RTCSdpType: "offer" | "pranswer" | "answer" | "rollback"

RTCSignalingState

RTCSignalingState: "stable" | "have-local-offer" | "have-remote-offer" | "have-local-pranswer" | "have-remote-pranswer" | "closed"

RTCStatsIceCandidatePairState

RTCStatsIceCandidatePairState: "frozen" | "waiting" | "inprogress" | "failed" | "succeeded" | "cancelled"

RTCStatsIceCandidateType

RTCStatsIceCandidateType: "host" | "serverreflexive" | "peerreflexive" | "relayed"

RTCStatsType

RTCStatsType: "inboundrtp" | "outboundrtp" | "session" | "datachannel" | "track" | "transport" | "candidatepair" | "localcandidate" | "remotecandidate"

RTCTransport

RTCTransport: RTCDtlsTransport | RTCSrtpSdesTransport

Readonly

Readonly: object

Make all properties in T readonly

Type declaration

ReadyState

ReadyState: "closed" | "open" | "ended"

Record

Record: object

Construct a type with a set of properties K of type T

Type declaration

ReferrerPolicy

ReferrerPolicy: "" | "no-referrer" | "no-referrer-when-downgrade" | "origin-only" | "origin-when-cross-origin" | "unsafe-url"

RenderingContext

RenderingContext: CanvasRenderingContext2D | ImageBitmapRenderingContext | WebGLRenderingContext

ReporterConstructor

ReporterConstructor: ReporterConstructor
deprecated

use Mocha.ReporterConstructor instead.

RequestCache

RequestCache: "default" | "no-store" | "reload" | "no-cache" | "force-cache" | "only-if-cached"

RequestCredentials

RequestCredentials: "omit" | "same-origin" | "include"

RequestDestination

RequestDestination: "" | "audio" | "audioworklet" | "document" | "embed" | "font" | "image" | "manifest" | "object" | "paintworklet" | "report" | "script" | "sharedworker" | "style" | "track" | "video" | "worker" | "xslt"

RequestInfo

RequestInfo: Request | string

RequestMode

RequestMode: "navigate" | "same-origin" | "no-cors" | "cors"

RequestRedirect

RequestRedirect: "follow" | "error" | "manual"

Required

Required: object

Make all properties in T required

Type declaration

ResponseType

ResponseType: "basic" | "cors" | "default" | "error" | "opaque" | "opaqueredirect"

ReturnType

ReturnType: ReturnType<T>

Obtain the return type of a function type

SVGMatrix

SVGMatrix: DOMMatrix

SVGPoint

SVGPoint: DOMPoint

SVGRect

SVGRect: DOMRect

ScopedCredentialType

ScopedCredentialType: "ScopedCred"

ScrollBehavior

ScrollBehavior: "auto" | "smooth"

ScrollLogicalPosition

ScrollLogicalPosition: "start" | "center" | "end" | "nearest"

ScrollRestoration

ScrollRestoration: "auto" | "manual"

ScrollSetting

ScrollSetting: "" | "up"

SelectionMode

SelectionMode: "select" | "start" | "end" | "preserve"

ServiceWorkerState

ServiceWorkerState: "installing" | "installed" | "activating" | "activated" | "redundant"

ServiceWorkerUpdateViaCache

ServiceWorkerUpdateViaCache: "imports" | "all" | "none"

ShadowRootMode

ShadowRootMode: "open" | "closed"

SpeechRecognitionErrorCode

SpeechRecognitionErrorCode: "no-speech" | "aborted" | "audio-capture" | "network" | "not-allowed" | "service-not-allowed" | "bad-grammar" | "language-not-supported"

SpeechSynthesisErrorCode

SpeechSynthesisErrorCode: "canceled" | "interrupted" | "audio-busy" | "audio-hardware" | "network" | "synthesis-unavailable" | "synthesis-failed" | "language-unavailable" | "voice-unavailable" | "text-too-long" | "invalid-argument"

SupportedType

SupportedType: "text/html" | "text/xml" | "application/xml" | "application/xhtml+xml" | "image/svg+xml"

TexImageSource

TexImageSource: ImageBitmap | ImageData | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement

TextTrackKind

TextTrackKind: "subtitles" | "captions" | "descriptions" | "chapters" | "metadata"

TextTrackMode

TextTrackMode: "disabled" | "hidden" | "showing"

ThresholdEffectiveBehavior

ThresholdEffectiveBehavior: "all" | "any"

All possible values of Threshold.effectiveBehavior

ThresholdSetStatus

ThresholdSetStatus: "draft" | "active" | "retired" | "unknown"

All possible values of ThresholdSet.status

TimerHandler

TimerHandler: string | Function

TouchType

TouchType: "direct" | "stylus"

Transferable

Transferable: ArrayBuffer | MessagePort | ImageBitmap

Transport

Transport: "usb" | "nfc" | "ble"

VRDisplayEventReason

VRDisplayEventReason: "mounted" | "navigation" | "requested" | "unmounted"

VibratePattern

VibratePattern: number | number[]

VideoFacingModeEnum

VideoFacingModeEnum: "user" | "environment" | "left" | "right"

VisibilityState

VisibilityState: "hidden" | "visible" | "prerender"

WebGLPowerPreference

WebGLPowerPreference: "default" | "low-power" | "high-performance"

WebKitCSSMatrix

WebKitCSSMatrix: DOMMatrix

WindowProxy

WindowProxy: Window

WorkerType

WorkerType: "classic" | "module"

XMLHttpRequestResponseType

XMLHttpRequestResponseType: "" | "arraybuffer" | "blob" | "document" | "json" | "text"

webkitURL

webkitURL: URL

Variables

Audio

Audio: object

Type declaration

  • constructor: function

    • Parameters

      • Optional src: undefined | string

      Returns HTMLAudioElement

Image

Image: object

Type declaration

  • constructor: function
    • new __type(width?: undefined | number, height?: undefined | number): HTMLImageElement

    • Parameters

      • Optional width: undefined | number
      • Optional height: undefined | number

      Returns HTMLImageElement

Const Infinity

Infinity: number

Const NaN

NaN: number

Option

Option: object

Type declaration

  • constructor: function
    • new __type(text?: undefined | string, value?: undefined | string, defaultSelected?: undefined | false | true, selected?: undefined | false | true): HTMLOptionElement

    • Parameters

      • Optional text: undefined | string
      • Optional value: undefined | string
      • Optional defaultSelected: undefined | false | true
      • Optional selected: undefined | false | true

      Returns HTMLOptionElement

Proxy

Proxy: ProxyConstructor

after

after: HookFunction

Execute after running tests.

  • Only available when invoked via the mocha CLI.
see

https://mochajs.org/api/global.html#after

afterEach

afterEach: HookFunction

Execute after each test case.

  • Only available when invoked via the mocha CLI.
see

https://mochajs.org/api/global.html#afterEach

applicationCache

applicationCache: ApplicationCache

before

before: HookFunction

Execute before running tests.

  • Only available when invoked via the mocha CLI.
see

https://mochajs.org/api/global.html#before

beforeEach

beforeEach: HookFunction

Execute before each test case.

  • Only available when invoked via the mocha CLI.
see

https://mochajs.org/api/global.html#beforeEach

caches

caches: CacheStorage

clientInformation

clientInformation: Navigator

closed

closed: boolean

console

console: Console

context

context: SuiteFunction

Describe a "suite" containing nested suites and tests.

  • Only available when invoked via the mocha CLI.

crypto

crypto: Crypto

customElements

customElements: CustomElementRegistry

defaultStatus

defaultStatus: string

describe

describe: SuiteFunction

Describe a "suite" containing nested suites and tests.

  • Only available when invoked via the mocha CLI.

devicePixelRatio

devicePixelRatio: number

doNotTrack

doNotTrack: string

document

document: Document

event

event: Event | undefined

external

external: External
deprecated

frameElement

frameElement: Element

frames

frames: Window

history

history: History

indexedDB

indexedDB: IDBFactory

innerHeight

innerHeight: number

innerWidth

innerWidth: number

isSecureContext

isSecureContext: boolean

it

it: TestFunction

Describes a test case.

  • Only available when invoked via the mocha CLI.

length

length: number

localStorage

localStorage: Storage

location

location: Location

locationbar

locationbar: BarProp

menubar

menubar: BarProp

Const mocha

mocha: BrowserMocha

Mocha global.

  • Only supported in the browser.

msContentScript

msContentScript: ExtensionScriptApis

Const name

name: never

navigator

navigator: Navigator

offscreenBuffering

offscreenBuffering: string | boolean

onabort

onabort: function | null

Fires when the user aborts the download.

param

The event.

onafterprint

onafterprint: function | null

onanimationcancel

onanimationcancel: function | null

onanimationend

onanimationend: function | null

onanimationiteration

onanimationiteration: function | null

onanimationstart

onanimationstart: function | null

onauxclick

onauxclick: function | null

onbeforeprint

onbeforeprint: function | null

onbeforeunload

onbeforeunload: function | null

onblur

onblur: function | null

Fires when the object loses the input focus.

param

The focus event.

oncancel

oncancel: function | null

oncanplay

oncanplay: function | null

Occurs when playback is possible, but would require further buffering.

param

The event.

oncanplaythrough

oncanplaythrough: function | null

onchange

onchange: function | null

Fires when the contents of the object or selection have changed.

param

The event.

onclick

onclick: function | null

Fires when the user clicks the left mouse button on the object

param

The mouse event.

onclose

onclose: function | null

oncompassneedscalibration

oncompassneedscalibration: function | null

oncontextmenu

oncontextmenu: function | null

Fires when the user clicks the right mouse button in the client area, opening the context menu.

param

The mouse event.

oncuechange

oncuechange: function | null

ondblclick

ondblclick: function | null

Fires when the user double-clicks the object.

param

The mouse event.

ondevicelight

ondevicelight: function | null

ondevicemotion

ondevicemotion: function | null

ondeviceorientation

ondeviceorientation: function | null

ondrag

ondrag: function | null

Fires on the source object continuously during a drag operation.

param

The event.

ondragend

ondragend: function | null

Fires on the source object when the user releases the mouse at the close of a drag operation.

param

The event.

ondragenter

ondragenter: function | null

Fires on the target element when the user drags the object to a valid drop target.

param

The drag event.

ondragexit

ondragexit: function | null

ondragleave

ondragleave: function | null

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

param

The drag event.

ondragover

ondragover: function | null

Fires on the target element continuously while the user drags the object over a valid drop target.

param

The event.

ondragstart

ondragstart: function | null

Fires on the source object when the user starts to drag a text selection or selected object.

param

The event.

ondrop

ondrop: function | null

ondurationchange

ondurationchange: function | null

Occurs when the duration attribute is updated.

param

The event.

onemptied

onemptied: function | null

Occurs when the media element is reset to its initial state.

param

The event.

onended

onended: function | null

Occurs when the end of playback is reached.

param

The event

onerror

onerror: ErrorEventHandler

Fires when an error occurs during object loading.

param

The event.

onfocus

onfocus: function | null

Fires when the object receives focus.

param

The event.

ongotpointercapture

ongotpointercapture: function | null

onhashchange

onhashchange: function | null

oninput

oninput: function | null

oninvalid

oninvalid: function | null

onkeydown

onkeydown: function | null

Fires when the user presses a key.

param

The keyboard event

onkeypress

onkeypress: function | null

Fires when the user presses an alphanumeric key.

param

The event.

onkeyup

onkeyup: function | null

Fires when the user releases a key.

param

The keyboard event

onlanguagechange

onlanguagechange: function | null

onload

onload: function | null

Fires immediately after the browser loads the object.

param

The event.

onloadeddata

onloadeddata: function | null

Occurs when media data is loaded at the current playback position.

param

The event.

onloadedmetadata

onloadedmetadata: function | null

Occurs when the duration and dimensions of the media have been determined.

param

The event.

onloadend

onloadend: function | null

onloadstart

onloadstart: function | null

Occurs when Internet Explorer begins looking for media data.

param

The event.

onlostpointercapture

onlostpointercapture: function | null

onmessage

onmessage: function | null

onmessageerror

onmessageerror: function | null

onmousedown

onmousedown: function | null

Fires when the user clicks the object with either mouse button.

param

The mouse event.

onmouseenter

onmouseenter: function | null

onmouseleave

onmouseleave: function | null

onmousemove

onmousemove: function | null

Fires when the user moves the mouse over the object.

param

The mouse event.

onmouseout

onmouseout: function | null

Fires when the user moves the mouse pointer outside the boundaries of the object.

param

The mouse event.

onmouseover

onmouseover: function | null

Fires when the user moves the mouse pointer into the object.

param

The mouse event.

onmouseup

onmouseup: function | null

Fires when the user releases a mouse button while the mouse is over the object.

param

The mouse event.

onmousewheel

onmousewheel: function | null

onmsgesturechange

onmsgesturechange: function | null

onmsgesturedoubletap

onmsgesturedoubletap: function | null

onmsgestureend

onmsgestureend: function | null

onmsgesturehold

onmsgesturehold: function | null

onmsgesturestart

onmsgesturestart: function | null

onmsgesturetap

onmsgesturetap: function | null

onmsinertiastart

onmsinertiastart: function | null

onmspointercancel

onmspointercancel: function | null

onmspointerdown

onmspointerdown: function | null

onmspointerenter

onmspointerenter: function | null

onmspointerleave

onmspointerleave: function | null

onmspointermove

onmspointermove: function | null

onmspointerout

onmspointerout: function | null

onmspointerover

onmspointerover: function | null

onmspointerup

onmspointerup: function | null

onoffline

onoffline: function | null

ononline

ononline: function | null

onorientationchange

onorientationchange: function | null
deprecated

onpagehide

onpagehide: function | null

onpageshow

onpageshow: function | null

onpause

onpause: function | null

Occurs when playback is paused.

param

The event.

onplay

onplay: function | null

Occurs when the play method is requested.

param

The event.

onplaying

onplaying: function | null

Occurs when the audio or video has started playing.

param

The event.

onpointercancel

onpointercancel: function | null

onpointerdown

onpointerdown: function | null

onpointerenter

onpointerenter: function | null

onpointerleave

onpointerleave: function | null

onpointermove

onpointermove: function | null

onpointerout

onpointerout: function | null

onpointerover

onpointerover: function | null

onpointerup

onpointerup: function | null

onpopstate

onpopstate: function | null

onprogress

onprogress: function | null

Occurs to indicate progress while downloading media data.

param

The event.

onratechange

onratechange: function | null

Occurs when the playback rate is increased or decreased.

param

The event.

onreadystatechange

onreadystatechange: function | null

onrejectionhandled

onrejectionhandled: function | null

onreset

onreset: function | null

Fires when the user resets a form.

param

The event.

onresize

onresize: function | null

onscroll

onscroll: function | null

Fires when the user repositions the scroll box in the scroll bar on the object.

param

The event.

onsecuritypolicyviolation

onsecuritypolicyviolation: function | null

onseeked

onseeked: function | null

Occurs when the seek operation ends.

param

The event.

onseeking

onseeking: function | null

Occurs when the current playback position is moved.

param

The event.

onselect

onselect: function | null

Fires when the current selection changes.

param

The event.

onstalled

onstalled: function | null

Occurs when the download has stopped.

param

The event.

onstorage

onstorage: function | null

onsubmit

onsubmit: function | null

onsuspend

onsuspend: function | null

Occurs if the load operation has been intentionally halted.

param

The event.

ontimeupdate

ontimeupdate: function | null

Occurs to indicate the current playback position.

param

The event.

ontoggle

ontoggle: function | null

ontouchcancel

ontouchcancel: function | null

ontouchend

ontouchend: function | null

ontouchmove

ontouchmove: function | null

ontouchstart

ontouchstart: function | null

ontransitioncancel

ontransitioncancel: function | null

ontransitionend

ontransitionend: function | null

ontransitionrun

ontransitionrun: function | null

ontransitionstart

ontransitionstart: function | null

onunhandledrejection

onunhandledrejection: function | null

onunload

onunload: function | null

onvolumechange

onvolumechange: function | null

Occurs when the volume is changed, or playback is muted or unmuted.

param

The event.

onvrdisplayactivate

onvrdisplayactivate: function | null

onvrdisplayblur

onvrdisplayblur: function | null

onvrdisplayconnect

onvrdisplayconnect: function | null

onvrdisplaydeactivate

onvrdisplaydeactivate: function | null

onvrdisplaydisconnect

onvrdisplaydisconnect: function | null

onvrdisplayfocus

onvrdisplayfocus: function | null

onvrdisplaypointerrestricted

onvrdisplaypointerrestricted: function | null

onvrdisplaypointerunrestricted

onvrdisplaypointerunrestricted: function | null

onvrdisplaypresentchange

onvrdisplaypresentchange: function | null

onwaiting

onwaiting: function | null

Occurs when playback stops because the next frame of a video resource is not available.

param

The event.

onwheel

onwheel: function | null

opener

opener: any

orientation

orientation: string | number
deprecated

origin

origin: string

outerHeight

outerHeight: number

outerWidth

outerWidth: number

pageXOffset

pageXOffset: number

pageYOffset

pageYOffset: number

parent

parent: Window

performance

performance: Performance

personalbar

personalbar: BarProp

screen

screen: Screen

screenLeft

screenLeft: number

screenTop

screenTop: number

screenX

screenX: number

screenY

screenY: number

scrollX

scrollX: number

scrollY

scrollY: number

scrollbars

scrollbars: BarProp

self

self: Window

sessionStorage

sessionStorage: Storage

setup

setup: HookFunction

Execute before each test case.

  • Only available when invoked via the mocha CLI.
see

https://mochajs.org/api/global.html#beforeEach

specify

specify: TestFunction

Describes a test case.

  • Only available when invoked via the mocha CLI.

speechSynthesis

speechSynthesis: SpeechSynthesis

status

status: string

statusbar

statusbar: BarProp

styleMedia

styleMedia: StyleMedia

suite

suite: SuiteFunction

Describe a "suite" containing nested suites and tests.

  • Only available when invoked via the mocha CLI.

suiteSetup

suiteSetup: HookFunction

Execute before running tests.

  • Only available when invoked via the mocha CLI.
see

https://mochajs.org/api/global.html#before

suiteTeardown

suiteTeardown: HookFunction

Execute after running tests.

  • Only available when invoked via the mocha CLI.
see

https://mochajs.org/api/global.html#after

teardown

teardown: HookFunction

Execute after each test case.

  • Only available when invoked via the mocha CLI.
see

https://mochajs.org/api/global.html#afterEach

test

test: TestFunction

Describes a test case.

  • Only available when invoked via the mocha CLI.

toolbar

toolbar: BarProp

top

top: Window

window

window: Window

xcontext

xcontext: PendingSuiteFunction

Pending suite.

  • Only available when invoked via the mocha CLI.

xdescribe

xdescribe: PendingSuiteFunction

Pending suite.

  • Only available when invoked via the mocha CLI.

xit

xit: PendingTestFunction

Describes a pending test case.

  • Only available when invoked via the mocha CLI.

xspecify

xspecify: PendingTestFunction

Describes a pending test case.

  • Only available when invoked via the mocha CLI.

Functions

Const _copyThresholdSetsToCarePlan

  • Copy all ThresholdSets from PlanDefinition to CarePlan

    Parameters

    • pd: PlanDefinition

      The PlanDefinition to copy ThresholdSets from

    • cp: CarePlan

      The CarePlan to copy ThresholdSets to

    Returns CarePlan

    The CarePlan with newly added ThresholdSets

Const _createActivity

  • Creates a CarePlanActivity from provided taskId

    Parameters

    • taskId: string | undefined

      The id for the task

    Returns CarePlanActivity

    The CarePlanActivity

Const _createTask

  • Creates a task with the canonical reference provided

    Parameters

    Returns Task

    The created task

Const _generateIsoDate

  • _generateIsoDate(): string

  • Creates an ISO-string for current time

    Returns string

    An ISO-string for current time

Const _generateRandomFourCharString

  • _generateRandomFourCharString(): string

  • Generates a random four character string

    Returns string

    A random four character string

Const _handleIdConflicts

  • Handles potential conflicts that could arise when adding a resource to a CarePlan's contained-array

    Parameters

    • resource: Resource

      The resource that is to be added to the CarePlan's contained-array

    • carePlan: CarePlan

      The CarePlan

    Returns Resource

    The resource in a form where it can be added to the CarePlan's contained-array

Const actionToActivity

  • Creates an Activity from a PlanDefinitionAction and a ThresholdSet and adds it to the CarePlan

    Parameters

    Returns CarePlan

    A new CarePlan containing the newly added activity

addEventListener

  • Type parameters

    • K: keyof WindowEventMap

    Parameters

    • type: K
    • listener: function
        • (this: Window, ev: WindowEventMap[K]): any

        • Parameters

          • this: Window
          • ev: WindowEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

    Returns void

alert

  • alert(message?: any): void

  • Parameters

    • Optional message: any

    Returns void

atob

  • atob(encodedString: string): string
  • atob(data: string): string

  • Parameters

    • encodedString: string

    Returns string

  • Parameters

    • data: string

    Returns string

blur

  • blur(): void

  • Returns void

btoa

  • btoa(rawString: string): string
  • btoa(data: string): string

  • Parameters

    • rawString: string

    Returns string

  • Parameters

    • data: string

    Returns string

cancelAnimationFrame

  • cancelAnimationFrame(handle: number): void

  • Parameters

    • handle: number

    Returns void

captureEvents

  • captureEvents(): void
  • deprecated

    Returns void

clearInterval

  • clearInterval(handle?: undefined | number): void

  • Parameters

    • Optional handle: undefined | number

    Returns void

clearTimeout

  • clearTimeout(handle?: undefined | number): void

  • Parameters

    • Optional handle: undefined | number

    Returns void

close

  • close(): void

  • Returns void

confirm

  • confirm(message?: undefined | string): boolean

  • Parameters

    • Optional message: undefined | string

    Returns boolean

createImageBitmap

  • Parameters

    Returns Promise<ImageBitmap>

  • Parameters

    Returns Promise<ImageBitmap>

decodeURI

  • decodeURI(encodedURI: string): string

  • Gets the unencoded version of an encoded Uniform Resource Identifier (URI).

    Parameters

    • encodedURI: string

      A value representing an encoded URI.

    Returns string

decodeURIComponent

  • decodeURIComponent(encodedURIComponent: string): string

  • Gets the unencoded version of an encoded component of a Uniform Resource Identifier (URI).

    Parameters

    • encodedURIComponent: string

      A value representing an encoded URI component.

    Returns string

departFocus

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    Returns boolean

encodeURI

  • encodeURI(uri: string): string

  • Encodes a text string as a valid Uniform Resource Identifier (URI)

    Parameters

    • uri: string

      A value representing an encoded URI.

    Returns string

encodeURIComponent

  • encodeURIComponent(uriComponent: string): string

  • Encodes a text string as a valid component of a Uniform Resource Identifier (URI).

    Parameters

    • uriComponent: string

      A value representing an encoded URI component.

    Returns string

escape

  • escape(string: string): string

  • Computes a new string in which certain characters have been replaced by a hexadecimal escape sequence.

    Parameters

    • string: string

      A string value

    Returns string

eval

  • eval(x: string): any

  • Evaluates JavaScript code and executes it.

    Parameters

    • x: string

      A String value that contains valid JavaScript code.

    Returns any

Const extractThresholdSetsFromCarePlan

  • Method for extracting all ThresholdSets from a CarePlan

    Parameters

    Returns Basic[]

fetch

  • Parameters

    Returns Promise<Response>

  • Parameters

    Returns Promise<Response>

focus

  • focus(): void

  • Returns void

getComputedStyle

  • Parameters

    • elt: Element
    • Optional pseudoElt: string | null

    Returns CSSStyleDeclaration

getMatchedCSSRules

  • Parameters

    • elt: Element
    • Optional pseudoElt: string | null

    Returns CSSRuleList

getSelection

  • Returns Selection

isFinite

  • isFinite(number: number): boolean

  • Determines whether a supplied number is finite.

    Parameters

    • number: number

      Any numeric value.

    Returns boolean

isNaN

  • isNaN(number: number): boolean

  • Returns a Boolean value that indicates whether a value is the reserved value NaN (not a number).

    Parameters

    • number: number

      A numeric value.

    Returns boolean

Const isReference

  • isReference(arg: any): boolean

  • A typeguard that checks if an argument is a Reference

    Parameters

    • arg: any

      The argument to check

    Returns boolean

matchMedia

  • Parameters

    • query: string

    Returns MediaQueryList

moveBy

  • moveBy(x: number, y: number): void

  • Parameters

    • x: number
    • y: number

    Returns void

moveTo

  • moveTo(x: number, y: number): void

  • Parameters

    • x: number
    • y: number

    Returns void

msWriteProfilerMark

  • msWriteProfilerMark(profilerMarkName: string): void

  • Parameters

    • profilerMarkName: string

    Returns void

open

  • open(url?: undefined | string, target?: undefined | string, features?: undefined | string, replace?: undefined | false | true): Window | null

  • Parameters

    • Optional url: undefined | string
    • Optional target: undefined | string
    • Optional features: undefined | string
    • Optional replace: undefined | false | true

    Returns Window | null

parseFloat

  • parseFloat(string: string): number

  • Converts a string to a floating-point number.

    Parameters

    • string: string

      A string that contains a floating-point number.

    Returns number

parseInt

  • parseInt(s: string, radix?: undefined | number): number

  • Converts A string to an integer.

    Parameters

    • s: string

      A string to convert into a number.

    • Optional radix: undefined | number

      A value between 2 and 36 that specifies the base of the number in numString. If this argument is not supplied, strings with a prefix of '0x' are considered hexadecimal. All other strings are considered decimal.

    Returns number

Const planDefinitionToCarePlan

  • Adds all content from the PlanDefinition to the CarePlan

    Parameters

    Returns CarePlan

    A new CarePlan containing the content the provided CarePlan contained, along with the newly copied content

postMessage

  • postMessage(message: any, targetOrigin: string, transfer?: Transferable[]): void

  • Parameters

    • message: any
    • targetOrigin: string
    • Optional transfer: Transferable[]

    Returns void

print

  • print(): void

  • Returns void

prompt

  • prompt(message?: undefined | string, _default?: undefined | string): string | null

  • Parameters

    • Optional message: undefined | string
    • Optional _default: undefined | string

    Returns string | null

queueMicrotask

  • queueMicrotask(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

releaseEvents

  • releaseEvents(): void
  • deprecated

    Returns void

removeEventListener

  • Type parameters

    • K: keyof WindowEventMap

    Parameters

    • type: K
    • listener: function
        • (this: Window, ev: WindowEventMap[K]): any

        • Parameters

          • this: Window
          • ev: WindowEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

    Returns void

requestAnimationFrame

  • Parameters

    Returns number

resizeBy

  • resizeBy(x: number, y: number): void

  • Parameters

    • x: number
    • y: number

    Returns void

resizeTo

  • resizeTo(x: number, y: number): void

  • Parameters

    • x: number
    • y: number

    Returns void

run

  • run(): void

  • Triggers root suite execution.

    • Only available if flag --delay is passed into Mocha.
    • Only available when invoked via the mocha CLI.
    see

    https://mochajs.org/api/global.html#runWithSuite

    Returns void

scroll

  • scroll(options?: ScrollToOptions): void
  • scroll(x: number, y: number): void

  • Parameters

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • scrollBy(options?: ScrollToOptions): void
  • scrollBy(x: number, y: number): void

  • Parameters

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollTo

  • scrollTo(options?: ScrollToOptions): void
  • scrollTo(x: number, y: number): void

  • Parameters

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

setInterval

  • setInterval(handler: TimerHandler, timeout?: undefined | number, ...arguments: any[]): number

  • Parameters

    • handler: TimerHandler
    • Optional timeout: undefined | number
    • Rest ...arguments: any[]

    Returns number

setTimeout

  • setTimeout(handler: TimerHandler, timeout?: undefined | number, ...arguments: any[]): number

  • Parameters

    • handler: TimerHandler
    • Optional timeout: undefined | number
    • Rest ...arguments: any[]

    Returns number

stop

  • stop(): void

  • Returns void

toString

  • toString(): string

  • Returns string

unescape

  • unescape(string: string): string

  • Computes a new string in which hexadecimal escape sequences are replaced with the character that it represents.

    Parameters

    • string: string

      A string value

    Returns string

webkitCancelAnimationFrame

  • webkitCancelAnimationFrame(handle: number): void

  • Parameters

    • handle: number

    Returns void

webkitConvertPointFromNodeToPage

  • Parameters

    Returns WebKitPoint

webkitConvertPointFromPageToNode

  • Parameters

    Returns WebKitPoint

webkitRequestAnimationFrame

  • Parameters

    Returns number

Generated using TypeDoc