kibana/api_docs/kbn_url_state.devdocs.json

{
  "id": "@kbn/url-state",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/url-state",
        "id": "def-common.useSyncToUrl",
        "type": "Function",
        "tags": [],
        "label": "useSyncToUrl",
        "description": [
          "\nSync any object with browser query string using @knb/rison"
        ],
        "signature": [
          "<TValueToSerialize>(key: string, restore: (data: TValueToSerialize) => void, cleanupOnHistoryNavigation?: boolean) => (valueToSerialize?: TValueToSerialize | undefined) => void"
        ],
        "path": "packages/kbn-url-state/use_sync_to_url.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/url-state",
            "id": "def-common.useSyncToUrl.$1",
            "type": "string",
            "tags": [],
            "label": "key",
            "description": [
              "query string param to use"
            ],
            "signature": [
              "string"
            ],
            "path": "packages/kbn-url-state/use_sync_to_url.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/url-state",
            "id": "def-common.useSyncToUrl.$2",
            "type": "Function",
            "tags": [],
            "label": "restore",
            "description": [
              "use this to handle restored state"
            ],
            "signature": [
              "(data: TValueToSerialize) => void"
            ],
            "path": "packages/kbn-url-state/use_sync_to_url.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/url-state",
            "id": "def-common.useSyncToUrl.$3",
            "type": "boolean",
            "tags": [],
            "label": "cleanupOnHistoryNavigation",
            "description": [
              "use history events to cleanup state on back / forward naviation. true by default"
            ],
            "signature": [
              "boolean"
            ],
            "path": "packages/kbn-url-state/use_sync_to_url.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}