Skip to content

Latest commit

 

History

History
101 lines (84 loc) · 2.62 KB

rules-unit-testing.api.md

File metadata and controls

101 lines (84 loc) · 2.62 KB

API Report File for "@firebase/rules-unit-testing"

Do not edit this file. It is a report generated by API Extractor.

import{defaultasfirebase_2}from'firebase/compat/app';import{FirebaseSignInProvider}from'@firebase/util';// @publicexportfunctionassertFails(pr: Promise<any>): Promise<any>;// @publicexportfunctionassertSucceeds<T>(pr: Promise<T>): Promise<T>;// @publicexporttypeEmulatorConfig={rules?: string;}&(HostAndPort|{});// @publicexportinterfaceHostAndPort{host: string;port: number;}// @publicexportfunctioninitializeTestEnvironment(config: TestEnvironmentConfig): Promise<RulesTestEnvironment>;// @publicexportinterfaceRulesTestContext{database(databaseURL?: string): firebase_2.database.Database;firestore(settings?: firebase_2.firestore.Settings): firebase_2.firestore.Firestore;storage(bucketUrl?: string): firebase_2.storage.Storage;}// @publicexportinterfaceRulesTestEnvironment{authenticatedContext(user_id: string,tokenOptions?: TokenOptions): RulesTestContext;cleanup(): Promise<void>;clearDatabase(): Promise<void>;clearFirestore(): Promise<void>;clearStorage(): Promise<void>;readonlyemulators: {database?: HostAndPort;firestore?: HostAndPort;storage?: HostAndPort;};readonlyprojectId: string;unauthenticatedContext(): RulesTestContext;// (undocumented)withSecurityRulesDisabled(callback: (context: RulesTestContext)=>Promise<void>): Promise<void>;}// @publicexportinterfaceTestEnvironmentConfig{database?: EmulatorConfig;firestore?: EmulatorConfig;hub?: HostAndPort;projectId?: string;storage?: EmulatorConfig;}// @publicexporttypeTokenOptions={iat?: number;exp?: number;auth_time?: number;provider_id?: 'anonymous';email?: string;email_verified?: boolean;phone_number?: string;name?: string;picture?: string;firebase?: {sign_in_provider: FirebaseSignInProvider;identities?: {[providerinFirebaseSignInProvider]?: string[];};};aud?: string;iss?: string;[claim: string]: unknown;uid?: never;sub?: never;user_id?: never;};// @publicexportfunctionwithFunctionTriggersDisabled<TResult>(fn: ()=>TResult|Promise<TResult>): Promise<TResult>;// @publicexportfunctionwithFunctionTriggersDisabled<TResult>(hub: {host: string;port: number;},fn: ()=>TResult|Promise<TResult>): Promise<TResult>;// (No @packageDocumentation comment for this package)
close