{ "id": "@kbn/rison", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/rison", "id": "def-common.decode", "type": "Function", "tags": [], "label": "decode", "description": [ "\nparse a rison string into a javascript structure." ], "signature": [ "(rison: string) => ", { "pluginId": "@kbn/rison", "scope": "common", "docId": "kibKbnRisonPluginApi", "section": "def-common.RisonValue", "text": "RisonValue" } ], "path": "src/platform/packages/shared/kbn-rison/kbn_rison.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/rison", "id": "def-common.decode.$1", "type": "string", "tags": [], "label": "rison", "description": [], "signature": [ "string" ], "path": "src/platform/packages/shared/kbn-rison/kbn_rison.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/rison", "id": "def-common.decodeArray", "type": "Function", "tags": [], "label": "decodeArray", "description": [ "\nparse an a-rison string into a javascript structure.\n\nthis simply adds array markup around the string before parsing." ], "signature": [ "(rison: string) => ", { "pluginId": "@kbn/rison", "scope": "common", "docId": "kibKbnRisonPluginApi", "section": "def-common.RisonValue", "text": "RisonValue" }, "[]" ], "path": "src/platform/packages/shared/kbn-rison/kbn_rison.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/rison", "id": "def-common.decodeArray.$1", "type": "string", "tags": [], "label": "rison", "description": [], "signature": [ "string" ], "path": "src/platform/packages/shared/kbn-rison/kbn_rison.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/rison", "id": "def-common.encode", "type": "Function", "tags": [], "label": "encode", "description": [ "\nrison-encode a javascript structure" ], "signature": [ "(obj: any) => string" ], "path": "src/platform/packages/shared/kbn-rison/kbn_rison.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/rison", "id": "def-common.encode.$1", "type": "Any", "tags": [], "label": "obj", "description": [], "signature": [ "any" ], "path": "src/platform/packages/shared/kbn-rison/kbn_rison.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/rison", "id": "def-common.encodeArray", "type": "Function", "tags": [], "label": "encodeArray", "description": [ "\nrison-encode a javascript array without surrounding parens" ], "signature": [ "(array: any[]) => any" ], "path": "src/platform/packages/shared/kbn-rison/kbn_rison.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/rison", "id": "def-common.encodeArray.$1", "type": "Array", "tags": [], "label": "array", "description": [], "signature": [ "any[]" ], "path": "src/platform/packages/shared/kbn-rison/kbn_rison.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/rison", "id": "def-common.encodeUnknown", "type": "Function", "tags": [], "label": "encodeUnknown", "description": [], "signature": [ "(obj: any) => string | undefined" ], "path": "src/platform/packages/shared/kbn-rison/kbn_rison.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/rison", "id": "def-common.encodeUnknown.$1", "type": "Any", "tags": [], "label": "obj", "description": [], "signature": [ "any" ], "path": "src/platform/packages/shared/kbn-rison/kbn_rison.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/rison", "id": "def-common.safeDecode", "type": "Function", "tags": [], "label": "safeDecode", "description": [ "\nsafely parse a rison string into a javascript structure, never throws" ], "signature": [ "(rison: string) => ", { "pluginId": "@kbn/rison", "scope": "common", "docId": "kibKbnRisonPluginApi", "section": "def-common.RisonValue", "text": "RisonValue" } ], "path": "src/platform/packages/shared/kbn-rison/kbn_rison.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/rison", "id": "def-common.safeDecode.$1", "type": "string", "tags": [], "label": "rison", "description": [], "signature": [ "string" ], "path": "src/platform/packages/shared/kbn-rison/kbn_rison.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [], "enums": [], "misc": [ { "parentPluginId": "@kbn/rison", "id": "def-common.RisonValue", "type": "Type", "tags": [], "label": "RisonValue", "description": [], "signature": [ "string | number | boolean | ", { "pluginId": "@kbn/rison", "scope": "common", "docId": "kibKbnRisonPluginApi", "section": "def-common.RisonValue", "text": "RisonValue" }, "[] | { [key: string]: ", { "pluginId": "@kbn/rison", "scope": "common", "docId": "kibKbnRisonPluginApi", "section": "def-common.RisonValue", "text": "RisonValue" }, "; } | null" ], "path": "src/platform/packages/shared/kbn-rison/kbn_rison.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [] } }