Function closeSession

  • Closes a session by setting its status and updating the session object with it. Internally calls updateSession to update the passed session object.

    Note that this function mutates the passed session (@see updateSession for explanation).

    Parameters

    • session: Session

      the Session object to be closed

    • Optional status: "exited" | "crashed" | "abnormal"

      the SessionStatus with which the session was closed. If you don't pass a status, this function will keep the previously set status, unless it was 'ok' in which case it is changed to 'exited'.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc