All files / platform/core/src/types RequestHeaders.ts

0% Statements 0/0
0% Branches 0/0
0% Functions 0/0
0% Lines 0/0

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36                                                                       
/**
 * Interface to clearly present the expected fields to linters when building a request header.
 */
export interface HeadersInterface {
  /**
   * Request Accept options. For example,
   * `['multipart/related; type=application/octet-stream; transfer-syntax=1.2.840.10008.1.2.1.99',]`.
   *
   * Defines to the server the formats it can use to deliver data to us.
   */
  Accept?: string[];
  /**
   * Request Authorization field. It can be overridden with the `requestOptions.auth` config item.
   * Contains the authorization credentials or tokens necessary to authorize the request with the
   * server.
   */
  Authorization?: string;
}
 
/**
 * Interface to clearly present the expected fields to linters when passing the configuration's
 * requestOptions struct.
 */
export interface RequestOptions {
  requestOptions?: {
    /**
     * Authentication options to include. Can be a function.
     */
    auth?: Function | string;
    /**
     * Authentication token. Satisfies the test requirement?
     */
    token?: string;
  }
}