模板语法
服务端渲染
API / @angular/common/http

HttpClientXsrfModule

An NgModule that adds XSRF protection support to outgoing requests.

一个NgModule，用于给外发请求添加 XSRF 保护。

class HttpClientXsrfModule { static disable(): ModuleWithProviders static withOptions(options: {...}): ModuleWithProviders }

说明

For a server that supports a cookie-based XSRF protection system, use directly to configure XSRF protection with the correct cookie and header names.

对于支持基于 Cookie 的 XSRF 保护系统的服务器来说，只要配置上正确的 Cookie 名和请求头的名字，就可以自动获得 XSRF 保护。

If no names are supplied, the default cookie name is XSRF-TOKEN and the default header name is X-XSRF-TOKEN.

如果没有提供名字，则默认的 Cookie 名是 XSRF-TOKEN，默认的请求头名字是 X-XSRF-TOKEN。

静态方法

disable()

Disable the default XSRF protection.

禁用默认的 XSRF 保护。

static disable(): ModuleWithProviders

参数

没有参数。

返回值

ModuleWithProviders

withOptions()

Configure XSRF protection.

配置 XSRF 保护。

static withOptions(options: { cookieName?: string; headerName?: string; } = {}): ModuleWithProviders

参数

options

An object that can specify either or both cookie name or header name.

一个对象，可以指定 Cookie 名和/或请求头的名字。

  • Cookie name default is XSRF-TOKEN.

    Cookie 名默认值是 XSRF-TOKEN。

  • Header name default is X-XSRF-TOKEN.

    请求头的名字默认是 X-XSRF-TOKEN。

可选. 默认值是 {}.

返回值

ModuleWithProviders

注解

@NgModule({ providers: [ HttpXsrfInterceptor, { provide: HTTP_INTERCEPTORS, useExisting: HttpXsrfInterceptor, multi: true }, { provide: HttpXsrfTokenExtractor, useClass: HttpXsrfCookieExtractor }, { provide: XSRF_COOKIE_NAME, useValue: 'XSRF-TOKEN' }, { provide: XSRF_HEADER_NAME, useValue: 'X-XSRF-TOKEN' }, ] })