Interface ClientMetadata

See

https://github.com/mongodb/specifications/blob/master/source/mongodb-handshake/handshake.rst#hello-command

interface ClientMetadata {
    application?: {
        name: string;
    };
    driver: {
        name: string;
        version: string;
    };
    env?: {
        memory_mb?: Int32;
        name: "aws.lambda" | "gcp.func" | "azure.func" | "vercel";
        region?: string;
        timeout_sec?: Int32;
        url?: string;
    };
    os: {
        architecture?: string;
        name?: Platform;
        type: string;
        version?: string;
    };
    platform: string;
}

Properties

application? driver env? os platform

Properties

Optional application

application?: {
    name: string;
}

Type declaration

  • name: string

driver

driver: {
    name: string;
    version: string;
}

Type declaration

  • name: string
  • version: string

Optional env

env?: {
    memory_mb?: Int32;
    name: "aws.lambda" | "gcp.func" | "azure.func" | "vercel";
    region?: string;
    timeout_sec?: Int32;
    url?: string;
}

FaaS environment information

Type declaration

  • Optional memory_mb?: Int32
  • name: "aws.lambda" | "gcp.func" | "azure.func" | "vercel"
  • Optional region?: string
  • Optional timeout_sec?: Int32
  • Optional url?: string

os

os: {
    architecture?: string;
    name?: Platform;
    type: string;
    version?: string;
}

Type declaration

  • Optional architecture?: string
  • Optional name?: Platform
  • type: string
  • Optional version?: string

platform

platform: string

Settings

Member Visibility

Theme

On This Page

applicationdriverenvosplatform