RequestBuilder | ng-request-builder

Chainable HTTP request builder.

example


let res: Observable<Response> = new RequestBuilder(http)
  .post('http://example.com')   // Set the URL
  .body({ foo: 'bar' })         // POST a JSON body with Content-Type application/json
  .execute();                   // Execute the HTTP request

let res2: Observable<Response> = new RequestBuilder(http)
  .get('http://example.com')
  .header('Authorization', 'Bearer secret')   // Set headers
  .search('page', 2)                          // Set search params
  .search('pageSize', 20)
  .execute();

Hierarchy

RequestBuilder

Index

Constructors

constructor

Constructors

constructor

new RequestBuilder(http?: Http, options?: RequestBuilderOptions): RequestBuilder

- Defined in src/request-builder.ts:40
Constructs a new request builder.

Parameters
- Optional http: Http
  
  Angular's Http service, used to perform the HTTP request when execute is called.
- Default value options: RequestBuilderOptions = {}
Returns RequestBuilder

Methods

appendAllSearchParams

appendAllSearchParams(params: URLSearchParams): this

- Defined in src/request-builder.ts:235
Parameters
- params: URLSearchParams
Returns this

appendHeader

appendHeader(name: string, value: string): RequestBuilder

Appends a value to the existing list of values for a header.

example


builder.header('Link', '<http://example.com/list?page=3&per_page=100>; rel="next"');
builder.header('Link', '<http://example.com/list?page=50&per_page=100>; rel="last"');

Parameters

name: string
value: string

Returns RequestBuilder

appendSearchParam

appendSearchParam(param: string, value: string): this

- Defined in src/request-builder.ts:230
Parameters
- param: string
- value: string
Returns this

body

body(content: any, contentType?: string): RequestBuilder

- Defined in src/request-builder.ts:135
Sets the request's body (and optionally its content type).

By default, the content type is application/json and the specified content is serialized with JSON.stringify.
example
```
builder.body({ foo: 'bar' });
```
Parameters
- content: any
- Optional contentType: string
Returns RequestBuilder

deleteHeader

deleteHeader(name: string): RequestBuilder

- Defined in src/request-builder.ts:181
Deletes all header values for the specified name.
example
```
builder.deleteHeader('Authorization');
```
Parameters
- name: string
Returns RequestBuilder

deleteSearchParam

deleteSearchParam(param: string): this

- Defined in src/request-builder.ts:240
Parameters
- param: string
Returns this

execute

execute(http?: Http): Observable<Response>

- Defined in src/request-builder.ts:288
Executes the configured HTTP request.
example
```
builder.execute().subscribe((res) => {
  // handle the response
});
```
Parameters
- Optional http: Http
  
  The Http service with which to execute the request (defaults to the one supplied to the constructor).
Returns Observable<Response>

header

header(name: string, value: string): RequestBuilder

- Defined in src/request-builder.ts:153
Alias of setHeader;

Parameters
- name: string
- value: string
Returns RequestBuilder

interceptor

interceptor(interceptor: ObservableInterceptorType): RequestBuilder

- Defined in src/request-builder.ts:270
Parameters
- interceptor: ObservableInterceptorType
Returns RequestBuilder

method

method(method: string | RequestMethod): RequestBuilder

- Defined in src/request-builder.ts:104
Sets the request's HTTP method (e.g. GET, POST).
example
```
builder.method('HEAD');
builder.method(RequestMethod.Patch);
```
Parameters
- method: string | RequestMethod
Returns RequestBuilder

modify

modify(func: function): this

- Defined in src/request-builder.ts:81
Supplies this builder's internal RequestOptions object to the specified function for modification.

This is provided so that request options can be freely modified if the provided chainable methods are not sufficient.
example
```
builder.modify((requestOptions: RequestOptions) => {
  requestOptions.method = RequestMethod.Post;
  requestOptions.body = JSON.stringify({ foo: 'bar' });
  requestOptions.headers = new Headers({
    'Content-Type': 'application/json'
  });
});
```
Parameters
- func: function
  - - (options: RequestOptions): any
    - Parameters
      - options: RequestOptions
      Returns any
Returns this

modifyHeaders

modifyHeaders(func: function): this

- Defined in src/request-builder.ts:215
Supplies this builder's internal Headers object to the specified function for modification.

This is provided so that headers can be freely modified if the provided chainable methods are not sufficient.
example
```
builder.modifyHeaders((headers: Headers) => {
  if (!headers.has('Authorization')) {
    headers.set('Authorization', 'Bearer secret');
  }
});
```
Parameters
- func: function
  - - (headers: Headers): any
    - Parameters
      - headers: Headers
      Returns any
Returns this

replaceAllSearchParams

replaceAllSearchParams(params: URLSearchParams): this

- Defined in src/request-builder.ts:245
Parameters
- params: URLSearchParams
Returns this

search

search(param: string, value: string): this

- Defined in src/request-builder.ts:226
Alias of setSearchParam.

Parameters
- param: string
- value: string
Returns this

setAllSearchParams

setAllSearchParams(params: URLSearchParams): this

- Defined in src/request-builder.ts:255
Parameters
- params: URLSearchParams
Returns this

setHeader

setHeader(name: string, value: string): RequestBuilder

- Defined in src/request-builder.ts:195
Sets or overrides the header value for the specified name.
example
```
builder.setHeader('Authorization', 'Bearer secret');
```
Parameters
- name: string
- value: string
Returns RequestBuilder

setOptions

setOptions(options: RequestOptions): RequestBuilder

- Defined in src/request-builder.ts:89
Parameters
- options: RequestOptions
Returns RequestBuilder

setResponseType

setResponseType(responseType: ResponseContentType): this

- Defined in src/request-builder.ts:265
Parameters
- responseType: ResponseContentType
Returns this

setSearchParam

setSearchParam(param: string, value: string): this

- Defined in src/request-builder.ts:250
Parameters
- param: string
- value: string
Returns this

setWithCredentials

setWithCredentials(withCredentials: boolean): this

- Defined in src/request-builder.ts:260
Parameters
- withCredentials: boolean
Returns this

url

url(url: string): RequestBuilder

- Defined in src/request-builder.ts:118
Sets the request's URL.
example
```
builder.url('http://example.com/path');
```
Parameters
- url: string
Returns RequestBuilder

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional http: Http

Default value options: RequestBuilderOptions = {}

Returns RequestBuilder

Methods

appendAllSearchParams

Parameters

params: URLSearchParams

Returns this

appendHeader

Parameters

name: string

value: string

Returns RequestBuilder

appendSearchParam

Parameters

param: string

value: string

Returns this

body

Parameters

content: any

Optional contentType: string

Returns RequestBuilder

deleteHeader

Parameters

name: string

Returns RequestBuilder

deleteSearchParam

Parameters

param: string

Returns this

execute

Parameters

Optional http: Http

Returns Observable<Response>

header

Parameters

name: string

value: string

Returns RequestBuilder

interceptor

Parameters

interceptor: ObservableInterceptorType

Returns RequestBuilder

method

Parameters

method: string | RequestMethod

Returns RequestBuilder

modify

Parameters

func: function

Parameters

options: RequestOptions

Returns any

Returns this

modifyHeaders

Parameters

func: function

Parameters

headers: Headers

Returns any

Returns this

replaceAllSearchParams

Parameters

params: URLSearchParams

Returns this

search

Parameters

param: string

value: string

Returns this

setAllSearchParams

Parameters