← All procedures

client.unshift

Add value to beginning of array (immutable)

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

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","unshift"], { items: [] });
console.log(JSON.stringify(result));

As data, in a program

{ "$proc": ["client", "unshift"], "input": { "items": [] } }

Input

FieldTypeRequired
itemsunknown[]yes
valueunknownno

Output

The schema does not list fields (any[]).

JSON Schemas
{
  "input": {
    "type": "object",
    "properties": {
      "items": {
        "type": "array",
        "items": {},
        "description": "The array"
      },
      "value": {
        "description": "The value"
      }
    },
    "required": [
      "items"
    ]
  },
  "output": {
    "type": "array",
    "items": {},
    "description": "The items with the new items at the start"
  }
}