Logo for jsDocs.io

@firebase/installations-types

  • Version 0.5.1
  • Published
  • 2.34 kB
  • No dependencies
  • Apache-2.0 license

Install

npm i @firebase/installations-types
yarn add @firebase/installations-types
pnpm add @firebase/installations-types

Overview

@firebase/installations Types

Index

Interfaces

Type Aliases

Interfaces

interface FirebaseInstallations

interface FirebaseInstallations {}

    method delete

    delete: () => Promise<void>;

    • Deletes the Firebase Installation and all associated data.

    method getId

    getId: () => Promise<string>;

    • Creates a Firebase Installation if there isn't one for the app and returns the Installation ID.

      Firebase Installation ID

    method getToken

    getToken: (forceRefresh?: boolean) => Promise<string>;

    • Returns an Authentication Token for the current Firebase Installation.

      Firebase Installation Authentication Token

    method onIdChange

    onIdChange: (callback: (installationId: string) => void) => () => void;

    • Sets a new callback that will get called when Installlation ID changes. Returns an unsubscribe function that will remove the callback when called.

    Type Aliases

    type FirebaseInstallationsName

    type FirebaseInstallationsName = 'installations';

      Package Files (1)

      Dependencies (0)

      No dependencies.

      Dev Dependencies (1)

      Peer Dependencies (1)

      Badge

      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@firebase/installations-types.

      • Markdown
        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@firebase/installations-types)
      • HTML
        <a href="https://www.jsdocs.io/package/@firebase/installations-types"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>