# All files / core types.ts

100% Statements 4/4
100% Branches 2/2
100% Functions 1/1
100% Lines 4/4

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63

    2x

    2x

    2x

    2x

     /**
     * Copyright 2017 Google Inc.
     *
     * Licensed under the Apache License, Version 2.0 (the "License");
     * you may not use this file except in compliance with the License.
     * You may obtain a copy of the License at
     *
     *   http://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.
     */

    /**
     * BatchID is a locally assigned ID for a batch of mutations that have been
     * applied.
     */
    export type BatchId = number;

    /**
     * A locally-assigned ID used to refer to a target being watched via the
     * Watch service.
     */
    export type TargetId = number;

    // TODO(b/35918695): In GRPC / node, tokens are Uint8Array. In WebChannel,
    // they're strings. We should probably (de-)serialize to a common internal type.
    export type ProtoByteString = Uint8Array | string;

    /**
     * Describes the online state of the Firestore client. Note that this does not
     * indicate whether or not the remote store is trying to connect or not. This is
     * primarily used by the View / EventManager code to change their behavior while
     * offline (e.g. get() calls shouldn't wait for data from the server and
     * snapshot events should set metadata.isFromCache=true).
     */
    export enum OnlineState {
      /**
       * The Firestore client is in an unknown online state. This means the client
       * is either not actively trying to establish a connection or it is currently
       * trying to establish a connection, but it has not succeeded or failed yet.
       * Higher-level components should not operate in offline mode.
       */
      Unknown,

      /**
       * The client is connected and the connections are healthy. This state is
       * reached after a successful connection and there has been at least one
       * successful message received from the backends.
       */
      Online,

      /**
       * The client is either trying to establish a connection but failing, or it
       * has been explicitly marked offline via a call to disableNetwork().
       * Higher-level components should operate in offline mode.
       */
      Offline
    }