Type alias HTMLPostMessageResponseOptions

HTMLPostMessageResponseOptions: {
    close?: boolean;
    closeDelay?: number;
    message: string;
    res: Response;
    status?: number | string;
    target?: string;
    title: string;
}

The options to build a response for a post message.

Type declaration

  • Optional close?: boolean

    Whether or not to call window.close after sending the message.

    Default

    true
  • Optional closeDelay?: number

    In case close is set to true, this option is to specify how many milliseconds should be waited before closing the window.

    Default

    700
  • message: string

    The contents of the post message.

  • res: Response

    The response object generated by the application.

  • Optional status?: number | string

    The status code for the response.

    Default

    200
  • Optional target?: string

    From which object will the postMessage method called from.

    Default

    'window.opener'
  • title: string

    The title for the HTML.

Settings

Member Visibility

Theme

Generated using TypeDoc