Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://googleapis.deno.dev/v1/firebaserules:v1.ts";

§Classes

FirebaseRules

Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.

GoogleAuth

§Variables

auth

§Interfaces

Arg

Arg matchers for the mock function.

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

ExpressionReport

Describes where in a file an expression is found and what it was evaluated to over the course of its use.

File

File containing source content.

FunctionCall

Represents a service-defined function call that was invoked during test execution.

FunctionMock

Mock function definition. Mocks must refer to a function declared by the target service. The type of the function args and result will be inferred at test time. If either the arg or result values are not compatible with function type declaration, the request will be considered invalid. More than one FunctionMock may be provided for a given function name so long as the Arg matchers are distinct. There may be only one function for a given overload where all Arg values are Arg.any_value.

GetReleaseExecutableResponse

The response for FirebaseRulesService.GetReleaseExecutable

Issue

Issues include warnings, errors, and deprecation notices.

ListReleasesResponse

The response for FirebaseRulesService.ListReleases.

ListRulesetsResponse

The response for FirebaseRulesService.ListRulesets.

Metadata

Metadata for a Ruleset.

ProjectsReleasesGetExecutableOptions

Additional options for FirebaseRules#projectsReleasesGetExecutable.

ProjectsReleasesListOptions

Additional options for FirebaseRules#projectsReleasesList.

ProjectsRulesetsListOptions

Additional options for FirebaseRules#projectsRulesetsList.

Release

Release is a named reference to a Ruleset. Once a Release refers to a Ruleset, rules-enabled services will be able to enforce the Ruleset.

Result

Possible result values from the function mock invocation.

Ruleset

Ruleset is an immutable copy of Source with a globally unique identifier and a creation time.

Source

Source is one or more File messages comprising a logical set of rules.

SourcePosition

Position in the Source content including its line, column number, and an index of the File in the Source message. Used for debug purposes.

TestCase

TestCase messages provide the request context and an expectation as to whether the given context will be allowed or denied. Test cases may specify the request, resource, and function_mocks to mock a function call to a service-provided function. The request object represents context present at request-time. The resource is the value of the target resource as it appears in persistent storage before the request is executed.

TestResult

Test result message containing the state of the test as well as a description and source position for test failures.

TestRulesetRequest

The request for FirebaseRulesService.TestRuleset.

TestRulesetResponse

The response for FirebaseRulesService.TestRuleset.

TestSuite

TestSuite is a collection of TestCase instances that validate the logical correctness of a Ruleset. The TestSuite may be referenced in-line within a TestRuleset invocation or as part of a Release object as a pre-release check.

UpdateReleaseRequest

The request for FirebaseRulesService.UpdateRelease.

ValueCount

Tuple for how many times an Expression was evaluated to a particular ExpressionValue.

VisitedExpression

Store the position and access outcome for an expression visited in rules.