Skip to content

@serenity-is/corelib / information

Variable: information()

const information: (message, onOk?, options?) => Partial<Dialog> = informationDialog

Defined in: src/compat/dialogs-compat.ts:22

Legacy information alias.

Displays an informational dialog with a single OK button.

Parameters

message

RenderableContent

Text or renderable content shown in the dialog body.

onOk?

() => void

Optional callback invoked when OK is clicked.

options?

MessageDialogOptions

Additional MessageDialogOptions.

Returns

Partial<Dialog>

A Dialog handle (partial when falling back to the native alert()).

Example

informationDialog("Operation complete", () => {
  // do something when OK is clicked
});

Deprecated

Use informationDialog instead.

See

informationDialog