mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-04-21 21:31:12 +08:00
48 lines
2.3 KiB
TypeScript
48 lines
2.3 KiB
TypeScript
// Type definitions for firebase-token-generator v2.0.0
|
|
// Project: https://github.com/firebase/firebase-token-generator-node
|
|
// Definitions by: Hans Van den Keybus <https://github.com/dotdotcommadot>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
interface TokenOptions {
|
|
expires?: number;
|
|
notBefore?: number;
|
|
admin?: boolean;
|
|
debug?: boolean;
|
|
simulate?: boolean;
|
|
iat?: number;
|
|
}
|
|
|
|
declare class FirebaseTokenGenerator {
|
|
|
|
/**
|
|
* Builds a new object that can generate Firebase authentication tokens.
|
|
* @constructor
|
|
* @param { String } secret The secret for the Firebase being used (get yours from the Firebase Admin Console).
|
|
*/
|
|
constructor(secret: string);
|
|
|
|
/**
|
|
* Creates a token that authenticates a client with arbitrary data "data", and the specified options.
|
|
*
|
|
* @param { any } data JSON data that will be passed to the Firebase Rules API once a client authenticates. Unless the
|
|
* "admin" flag is set, it must contain a "uid" key, and if it does it must be a string of length
|
|
* 256 or less.
|
|
* @param { TokenOptions } options The developer-supplied options for this token. Supported options are:
|
|
* a) "expires" -- A timestamp (as a number of seconds since the epoch) denoting a time after which
|
|
* this token should no longer be valid.
|
|
* b) "notBefore" -- A timestamp (as a number of seconds since the epoch) denoting a time before
|
|
* which this token should be rejected by the server.
|
|
* c) "admin" -- Set to true to bypass all security rules (use this for your trusted servers).
|
|
* d) "debug" -- Set to true to enable debug mode (so you can see the results of Rules API operations)
|
|
* e) "simulate" -- (internal-only for now) Set to true to neuter all API operations (listens / puts
|
|
* will run security rules but not actually write or return data)
|
|
* f) "iat" -- (Number) (internal-only, for testing) Set the issued at time for the generated token
|
|
* @return {String} The authentication token
|
|
*/
|
|
createToken(data: any, options?: TokenOptions): string;
|
|
}
|
|
|
|
declare module 'firebase-token-generator' {
|
|
export = FirebaseTokenGenerator;
|
|
}
|