HttpContext — Angular

Контекст HTTP хранит произвольные значения, определяемые пользователем, и обеспечивает типобезопасность, даже если типы неизвестны. Он основан на Map и гарантирует, что ключи не конфликтуют.

API

class HttpContext {
  set<T>(token: HttpContextToken<T>, value: T): HttpContext;
  get<T>(token: HttpContextToken<T>): T;
  delete(token: HttpContextToken<unknown>): HttpContext;
  has(token: HttpContextToken<unknown>): boolean;
  keys(): IterableIterator<HttpContextToken<unknown>>;
}

set

HttpContext

Сохраняет значение в контексте. Если значение уже существует, оно будет перезаписано.

@paramtokenHttpContextToken<T>

Ссылка на экземпляр HttpContextToken.

@paramvalueT

Сохраняемое значение.

@returnsHttpContext

Ссылка на этот объект для удобной цепочки вызовов.

get

T

Получает значение, связанное с указанным токеном.

@paramtokenHttpContextToken<T>

Ссылка на экземпляр HttpContextToken.

@returnsT

Сохраненное значение или значение по умолчанию, если оно задано.

delete

HttpContext

Удаляет значение, связанное с указанным токеном.

@paramtokenHttpContextToken<unknown>

Ссылка на экземпляр HttpContextToken.

@returnsHttpContext

Ссылка на этот объект для удобной цепочки вызовов.

has

boolean

Проверяет, существует ли указанный токен.

@paramtokenHttpContextToken<unknown>

Ссылка на экземпляр HttpContextToken.

@returnsboolean

True, если токен существует, иначе false.

keys

IterableIterator<HttpContextToken<unknown>>

@returnsIterableIterator<HttpContextToken<unknown>>

список токенов, сохраненных в контексте.

Описание

Этот контекст является изменяемым и используется совместно клонированными запросами, если не указано иное.

Примечания по использованию

Пример использования

// inside cache.interceptors.ts
export const IS_CACHE_ENABLED = new HttpContextToken<boolean>(() => false);

export class CacheInterceptor implements HttpInterceptor {

  intercept(req: HttpRequest<any>, delegate: HttpHandler): Observable<HttpEvent<any>> {
    if (req.context.get(IS_CACHE_ENABLED) === true) {
      return ...;
    }
    return delegate.handle(req);
  }
}

// inside a service

this.httpClient.get('/api/weather', {
  context: new HttpContext().set(IS_CACHE_ENABLED, true)
}).subscribe(...);