NGINX · Schema

NgxShared

The ngx.shared object provides access to shared memory zones declared with js_shared_dict_zone.

API GatewayCachingCloud NativeLoad BalancerOpen SourceReverse ProxyWeb Server
View JSON Schema on GitHub

JSON Schema

njs-ngx-shared-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/json-schema/njs-ngx-shared-schema.json",
  "title": "NgxShared",
  "description": "The ngx.shared object provides access to shared memory zones declared with js_shared_dict_zone.",
  "type": "object",
  "additionalProperties": {
    "type": "object",
    "description": "A shared dictionary zone that can be used to share data between worker processes.",
    "properties": {
      "name": {
        "type": "string",
        "readOnly": true,
        "description": "Name of the shared dictionary zone.",
        "example": "my_shared_zone"
      },
      "type": {
        "type": "string",
        "readOnly": true,
        "description": "Type of the shared dictionary (string or number).",
        "example": "string"
      }
    }
  }
}