5 lines
3.7 KiB
JSON
Raw Permalink Normal View History

{
"id": "api/platform-browser/StateKey",
"title": "StateKey",
"contents": "\n\n<article>\n <div class=\"breadcrumb-container\">\n <div class=\"breadcrumb\">\n <script type=\"application/ld+json\">\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"BreadcrumbList\",\n \"itemListElement\": [\n { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io//api\", \"name\": \"API\" } },\n { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/platform-browser\", \"name\": \"@angular/platform-browser\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/platform-browser/StateKey\", \"name\": \"StateKey\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/platform-browser\">@angular/platform-browser</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/platform-browser/src/browser/transfer_state.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L33-L48\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/browser/transfer_state.ts#L33-L48\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n \n <header class=\"api-header\">\n <h1 id=\"statekey\">StateKey<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/StateKey#statekey\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label type-alias\">type-alias</label>\n \n \n \n </header>\n \n <aio-toc class=\"embedded\"></aio-toc>\n\n <div class=\"api-body\">\n \n <section class=\"short-description\">\n <p>A type-safe key to use with <code><a href=\"api/platform-browser/TransferState\" class=\"code-anchor\">TransferState</a></code>.</p>\n\n <p><a href=\"api/platform-browser/StateKey#description\">See more...</a></p>\n </section>\n \n \n \n <section class=\"type-alias-overview\">\n <code-example language=\"ts\" hidecopy=\"true\">\n type <a href=\"api/platform-browser/StateKey\" class=\"code-anchor\">StateKey</a>&#x3C;T> = string &#x26; {\n __not_a_string: never;\n};\n </code-example>\n </section>\n\n \n\n \n \n<section class=\"description\">\n <h2 id=\"description\">Description<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/StateKey#description\"><i class=\"material-icons\">link</i></a></h2>\n <p>Example:</p>\n<code-example>\nconst COUNTER_KEY = <a href=\"api/platform-browser/makeStateKey\" class=\"code-anchor\">makeStateKey</a>&#x3C;number>('counter');\nlet value = 10;\n\ntransferState.set(COUNTER_KEY, value);\n</code-example>\n\n \n</section>\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/platform-browser\n - api/platform-browser/TransferState\n - api/platform-browser/makeStateKey\n-->\n<!-- links from this doc:\n - /api\n - api/platform-browser\n - api/platform-browser/StateKey#description\n - api/platform-browser/StateKey#statekey\n - api/platform-browser/TransferState\n - api/platform-browser/makeStateKey\n - https://github.com/angular/angular/edit/master/packages/platform-browser/src/browser/transfer_state.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L33-L48\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/browser/transfer_state.ts#L33-L48\n-->"
}