Setu-TS
    Preparing search index...

    Type Alias BigtableAdapterOptions

    BigtableAdapterOptions:
        | BigtableAdapterOptionsBase & {
            apiEndpoint?: string;
            client?: IBigtableClient;
            projectId: string;
        }
        | BigtableAdapterOptionsBase & {
            apiEndpoint?: string;
            client: IBigtableClient;
            projectId?: string;
        }

    Options for the BigtableAdapter — the 'bigtable' arm.

    A union of two arms, so supplying neither a projectId nor a client is a compile error rather than a connect() throw. Both members stay readable on either arm, so the adapter reads options.client and options.projectId without narrowing first.

    Type Declaration

    • BigtableAdapterOptionsBase & {
          apiEndpoint?: string;
          client?: IBigtableClient;
          projectId: string;
      }
      • Optional ReadonlyapiEndpoint?: string

        An explicit API endpoint, such as 127.0.0.1:8086 for cbtemulator. Measured: an endpoint alone reaches the emulator with no BIGTABLE_EMULATOR_HOST and no credentials.

      • Optional Readonlyclient?: IBigtableClient

        An already-constructed client; omit it to load the SDK lazily.

      • ReadonlyprojectId: string

        The GCP project, used to construct a client when none is injected.

    • BigtableAdapterOptionsBase & {
          apiEndpoint?: string;
          client: IBigtableClient;
          projectId?: string;
      }
      • Optional ReadonlyapiEndpoint?: string

        The API endpoint; unread once a client is injected.

      • Readonlyclient: IBigtableClient

        An already-constructed IBigtableClient.

        When present, the lazy import('@google-cloud/bigtable') never runs — the seam that keeps the branching unit-testable.

      • Optional ReadonlyprojectId?: string

        The GCP project; unread once a client is injected.

    const lazy: BigtableAdapterOptions = { projectId: 'p', instance: 'i' };
    const injected: BigtableAdapterOptions = { client: myBigtableClient, instance: 'i' };

    0.2.0

    Settings
    Member Visibility