angular-cn/aio/dist/generated/docs/api/common/http/HttpClientXsrfModule.json

5 lines
12 KiB
JSON
Raw Normal View History

{
"id": "api/common/http/HttpClientXsrfModule",
"title": "HttpClientXsrfModule",
"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/common\", \"name\": \"@angular/common\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/common/http\", \"name\": \"@angular/common/http\" } },\n { \"@type\": \"ListItem\", \"position\": 4, \"item\": { \"@id\": \"https://angular.io/api/common/http/HttpClientXsrfModule\", \"name\": \"HttpClientXsrfModule\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/common\">@angular/common</a> > <a href=\"api/common/http\">@angular/common/http</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/http/src/module.ts?message=docs(common)%3A%20describe%20your%20change...#L77-L132\" 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/common/http/src/module.ts#L77-L132\" 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=\"httpclientxsrfmodule\">HttpClientXsrfModule<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClientXsrfModule#httpclientxsrfmodule\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label ngmodule\">ngmodule</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>Configures XSRF protection support for outgoing requests.</p>\n\n <p><a href=\"api/common/http/HttpClientXsrfModule#description\">See more...</a></p>\n </section>\n \n \n \n <section class=\"ngmodule-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nclass <a href=\"api/common/http/HttpClientXsrfModule\" class=\"code-anchor\">HttpClientXsrfModule</a> {\n <a class=\"code-anchor\" href=\"api/common/http/HttpClientXsrfModule#disable\">static <span class=\"member-name\">disable</span>(): ModuleWithProviders&#x3C;HttpClientXsrfModule></a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpClientXsrfModule#withOptions\">static <span class=\"member-name\">withOptions</span>(options: { cookieName?: string; headerName?: string; } = {}): ModuleWithProviders&#x3C;HttpClientXsrfModule></a>\n}\n</code-example>\n\n \n \n\n</section>\n\n\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/common/http/HttpClientXsrfModule#description\"><i class=\"material-icons\">link</i></a></h2>\n <p>For a server that supports a cookie-based XSRF protection system,\nuse directly to configure XSRF protection with the correct\ncookie and header names.</p>\n<p>If no names are supplied, the default cookie name is <code>XSRF-TOKEN</code>\nand the default header name is <code>X-XSRF-TOKEN</code>.</p>\n\n \n</section>\n\n \n\n \n\n<section class=\"static-methods\">\n <h2 id=\"static-methods\">Static methods<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClientXsrfModule#static-methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"disable\"></a>\n<table class=\"is-full-width method-table static-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"disable\">\n di
}