CognitiveX Docs
SDK

heartbeat

Function from @cognitivx/api-client

heartbeat

Kind: Function Source: packages/api-client/src/endpoints/senses.ts:61 Generated from the TypeScript source for @cognitivx/api-client.

Signature

heartbeat(id, status)

Parameters

[
  {
    "name": "id",
    "type": {
      "type": "intrinsic",
      "name": "string"
    },
    "summary": ""
  },
  {
    "name": "status",
    "type": {
      "type": "reference",
      "target": {
        "packageName": "typescript",
        "packagePath": "lib/lib.es5.d.ts",
        "qualifiedName": "Record"
      },
      "typeArguments": [
        {
          "type": "intrinsic",
          "name": "string"
        },
        {
          "type": "intrinsic",
          "name": "unknown"
        }
      ],
      "name": "Record",
      "package": "typescript"
    },
    "summary": ""
  }
]

TypeDoc reflection

{
  "name": "heartbeat",
  "kind": "Function",
  "source": "packages/api-client/src/endpoints/senses.ts:61"
}