Back to Firebase Js Sdk

LiveServerGoingAwayNotice interface

docs-devsite/ai.liveservergoingawaynotice.md

12.12.11.6 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

LiveServerGoingAwayNotice interface

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Notification that the server will not be able to service the client soon.

<b>Signature:</b>

typescript
export interface LiveServerGoingAwayNotice 

Properties

PropertyTypeDescription
timeLeftnumber<b><i>(Public Preview)</i></b> The remaining time (in seconds) before the connection will be terminated.
type'goingAwayNotice'<b><i>(Public Preview)</i></b>

LiveServerGoingAwayNotice.timeLeft

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The remaining time (in seconds) before the connection will be terminated.

<b>Signature:</b>

typescript
timeLeft: number;

LiveServerGoingAwayNotice.type

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

<b>Signature:</b>

typescript
type: 'goingAwayNotice';