← All procedures

client.pick

Pick specified keys from object

browsernot registered
Package
@procedures/client · README
Path
["client","pick"]
CLI
Not a mark command: it is not in the default registry.
As data
{"$proc":["client","pick"],"input":{}}
Tags
core, object

Try it in the Composer →

Use it

In TypeScript

import { Client, LocalTransport, PROCEDURE_REGISTRY, allCoreProcedures } from "@procedures/client";

for (const procedure of allCoreProcedures) {
  if (!PROCEDURE_REGISTRY.has(procedure.path)) PROCEDURE_REGISTRY.register(procedure);
}

const client = new Client(new LocalTransport({ registry: PROCEDURE_REGISTRY }));
const result = await client.exec(["client","pick"], { object: {}, keys: [] });
console.log(JSON.stringify(result));

As data, in a program

{ "$proc": ["client", "pick"], "input": { "object": {}, "keys": [] } }

Input

FieldTypeRequired
objectRecord<string, unknown>yes
keysstring[]yes

Output

The schema does not list fields (object).

JSON Schemas
{
  "input": {
    "type": "object",
    "properties": {
      "object": {
        "type": "object",
        "propertyNames": {
          "type": "string"
        },
        "additionalProperties": {},
        "description": "The object"
      },
      "keys": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "The keys"
      }
    },
    "required": [
      "object",
      "keys"
    ]
  },
  "output": {
    "type": "object",
    "propertyNames": {
      "type": "string"
    },
    "additionalProperties": {},
    "description": "The object with only the given keys"
  }
}