docs(API): 翻译完了 HttpClientModule
This commit is contained in:
parent
10ddb2449f
commit
59425a1e5e
|
@ -28,7 +28,7 @@
|
|||
[x] |router/Routes | 2,331 | 0.72
|
||||
[x] |router/RouterModule | 2,227 | 0.69
|
||||
[x] |router/Route | 2,223 | 0.69
|
||||
[ ] |common/http/HttpClientModule | 2,167 | 0.67
|
||||
[x] |common/http/HttpClientModule | 2,167 | 0.67
|
||||
[ ] |core/ElementRef | 2,163 | 0.67
|
||||
[ ] |core/OnInit | 2,136 | 0.66
|
||||
[ ] |common/UpperCasePipe | 2,078 | 0.65
|
||||
|
|
|
@ -22,9 +22,15 @@ import {HttpXsrfCookieExtractor, HttpXsrfInterceptor, HttpXsrfTokenExtractor, XS
|
|||
* An injectable `HttpHandler` that applies multiple interceptors
|
||||
* to a request before passing it to the given `HttpBackend`.
|
||||
*
|
||||
* 一个可注入的 `HttpHandler`,它可以在把请求传给指定的 `HttpBackend` 之前,使用多个拦截器对该请求进行处理。
|
||||
*
|
||||
* The interceptors are loaded lazily from the injector, to allow
|
||||
* interceptors to themselves inject classes depending indirectly
|
||||
* on `HttpInterceptingHandler` itself.
|
||||
*
|
||||
* 这些拦截器是由注入器惰性加载起来的,以便让这些拦截器可以把其它类作为依赖注入进来,
|
||||
* 还可以让它们间接注入 `HttpInterceptingHandler` 自己。
|
||||
*
|
||||
* @see `HttpInterceptor`
|
||||
*/
|
||||
@Injectable()
|
||||
|
@ -47,8 +53,11 @@ export class HttpInterceptingHandler implements HttpHandler {
|
|||
* Constructs an `HttpHandler` that applies interceptors
|
||||
* to a request before passing it to the given `HttpBackend`.
|
||||
*
|
||||
* 构造一个 `HttpHandler`,它会在把请求传给指定的 `HttpBackend` 之前,先对该请求应用各个拦截器。
|
||||
*
|
||||
* Use as a factory function within `HttpClientModule`.
|
||||
*
|
||||
* 在 `HttpClientModule` 中用作工厂函数。
|
||||
*
|
||||
*/
|
||||
export function interceptingHandler(
|
||||
|
@ -63,9 +72,12 @@ export function interceptingHandler(
|
|||
/**
|
||||
* Factory function that determines where to store JSONP callbacks.
|
||||
*
|
||||
* 一个工厂函数,用来决定在哪里保存 JSONP 回调。
|
||||
*
|
||||
* Ordinarily JSONP callbacks are stored on the `window` object, but this may not exist
|
||||
* in test environments. In that case, callbacks are stored on an anonymous object instead.
|
||||
*
|
||||
* 原始的 JSONP 回调保存在 `window` 对象上,不过测试环境下可能不存在 `window` 对象。这时,回调就会转而保存在一个匿名对象上。
|
||||
*
|
||||
*/
|
||||
export function jsonpCallbackContext(): Object {
|
||||
|
@ -78,13 +90,18 @@ export function jsonpCallbackContext(): Object {
|
|||
/**
|
||||
* An NgModule that adds XSRF protection support to outgoing requests.
|
||||
*
|
||||
* 一个NgModule,用于给外发请求添加 XSRF 保护。
|
||||
*
|
||||
* 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`。
|
||||
*
|
||||
*/
|
||||
@NgModule({
|
||||
|
@ -99,6 +116,8 @@ export function jsonpCallbackContext(): Object {
|
|||
export class HttpClientXsrfModule {
|
||||
/**
|
||||
* Disable the default XSRF protection.
|
||||
*
|
||||
* 禁用默认的 XSRF 保护。
|
||||
*/
|
||||
static disable(): ModuleWithProviders {
|
||||
return {
|
||||
|
@ -111,11 +130,22 @@ export class HttpClientXsrfModule {
|
|||
|
||||
/**
|
||||
* Configure XSRF protection.
|
||||
*
|
||||
* 配置 XSRF 保护。
|
||||
*
|
||||
* @param 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`。
|
||||
*
|
||||
*/
|
||||
static withOptions(options: {
|
||||
cookieName?: string,
|
||||
|
@ -134,14 +164,20 @@ export class HttpClientXsrfModule {
|
|||
/**
|
||||
* An NgModule that provides the `HttpClient` and associated services.
|
||||
*
|
||||
* 一个 NgModule,可以提供 `HttpClient` 及其相关服务。
|
||||
*
|
||||
* Interceptors can be added to the chain behind `HttpClient` by binding them
|
||||
* to the multiprovider for `HTTP_INTERCEPTORS`.
|
||||
*
|
||||
*
|
||||
* 通过把拦截器提供为 `HTTP_INTERCEPTORS`(允许有多个),可以把它们添加到 `HttpClient` 调用链的后面。
|
||||
*
|
||||
*/
|
||||
@NgModule({
|
||||
/**
|
||||
* Optional configuration for XSRF protection.
|
||||
*
|
||||
* 可选的 XSRF 保护的配置项。
|
||||
*/
|
||||
imports: [
|
||||
HttpClientXsrfModule.withOptions({
|
||||
|
@ -151,6 +187,8 @@ export class HttpClientXsrfModule {
|
|||
],
|
||||
/**
|
||||
* The module provides `HttpClient` itself, and supporting services.
|
||||
*
|
||||
* 该模块提供 `HttpClient` 自身,以及用来支持它的那些服务。
|
||||
*/
|
||||
providers: [
|
||||
HttpClient,
|
||||
|
@ -167,10 +205,13 @@ export class HttpClientModule {
|
|||
/**
|
||||
* An NgModule that enables JSONP support in `HttpClient`.
|
||||
*
|
||||
* 一个 NgModule,用来为 `HttpClient` 启用 JSONP 支持。
|
||||
*
|
||||
* Without this module, Jsonp requests will reach the backend
|
||||
* with method JSONP, where they'll be rejected.
|
||||
*
|
||||
*
|
||||
* 如果没有该模块,则 Jsonp 请求会通过 `JSONP` 方法传给后端,它们通常会被服务器拒绝。
|
||||
*/
|
||||
@NgModule({
|
||||
providers: [
|
||||
|
|
Loading…
Reference in New Issue