Class RequestBuilderImpl`Internal`

RequestBuilderImpl

Description

Default implementation of the RequestBuilder interface

See

RequestBuilder - RequestBuilderImpl interface

Hierarchy

RequestBuilderImpl

Implements

RequestBuilder

Index

Constructors

constructor

new RequestBuilderImpl(entity): RequestBuilderImpl
Creates a new RequestBuilderImpl
Parameters
- entity: string
  
  The entity to make the request for
Returns RequestBuilderImpl
Example
```
new ODataRequest('Fractie')
```
- Defined in RequestBuilder/RequestBuilderImpl.ts:82

Properties - ODataOptions

`Optional` _count

_count?: boolean = false

Whether to count the amount of results

`Optional` _expand

_expand?: string[][] = []

The attributes to select

`Optional` _filter

_filter?: string[][] = []

The attributes to filter by

`Optional` _format

_format?: "none" | "minimal" | "full"

The format to return the results in

`Optional` _orderby

_orderby?: string[]

The order to sort the results by

_select

_select: string[] = []

The attributes to select

`Optional` _skip

_skip?: number

Amount of results to skip

`Optional` _top

_top?: number

Amount of results to return

Properties - Other

`Optional` _custom

_custom?: string

Custom query option

_endpoint

_endpoint: string = 'https://gegevensmagazijn.tweedekamer.nl/OData/v4/2.0'

Endpoint to make the request to

Default

"https://gegevensmagazijn.tweedekamer.nl/OData/v4/2.0"

_entity

_entity: string

Entity to make the request for

`Optional` _id

_id?: string

Unique id of the entity

Methods - Advanced/Development functions

endpoint

endpoint(endpoint): RequestBuilder
Experimental
Overwrite the default endpoint
Parameters
- endpoint: string
  
  The endpoint to use
Returns RequestBuilder
The RequestBuilderImpl
Example
```
new ODataRequest('Fractie')
   .endpoint('https://proxy.tweedekamer.nl/OData/v4/2.0')
```
Implementation of RequestBuilder.endpoint
- Defined in RequestBuilder/RequestBuilderImpl.ts:228

Methods - OData functions

count

count(count): RequestBuilder
Count the amount of results
Parameters
- count: boolean
  
  Whether to count the amount of results
Returns RequestBuilder
The RequestBuilderImpl
Example
```
new ODataRequest('Fractie')
   .count(true)
```
Example
```
new ODataRequest('Fractie')
   .count(false)
```
Implementation of RequestBuilder.count
- Defined in RequestBuilder/RequestBuilderImpl.ts:143

expand

expand(attribute, func?): RequestBuilder

Expand the request to include information from other entities

Parameters

attribute: string

The attribute to expand
Optional func: string

The function to apply to the attribute

Returns RequestBuilder

The RequestBuilderImpl

Example

new ODataRequest('Fractie')
    .expand('FractieZetel')
    .expand('Stemming', '$select=Soort')

Example

new ODataRequest('Fractie')
    .expand('FractieZetel')
    // Multiple functions can be applied to the same expansion
    // Using a semicolon (;) to separate them
    .expand('Stemming', "$top=1 ; $select=Soort")

filter

filter(expression): RequestBuilder
Filter the results
Parameters
- expression: string
  
  The expression to format the results with
Returns RequestBuilder
The RequestBuilderImpl
Example
```
new ODataRequest('Fractie')
 .filter("Afkorting eq 'VVD'")
```
Example
```
new ODataRequest('Fractie')
 .filter("AantalZetels gt 10")
 .filter("AantalZetels lt 20")
```
Implementation of RequestBuilder.filter
- Defined in RequestBuilder/RequestBuilderImpl.ts:205

format

format(format): RequestBuilder
The amount of metadata to return with the results
Parameters
- format: "none" | "minimal" | "full"
  
  The format to use
Returns RequestBuilder
The RequestBuilderImpl
Example
```
new ODataRequest('Fractie')
 .format('none')
```
Example
```
new ODataRequest('Fractie')
 .format('minimal')
```
Example
```
new ODataRequest('Fractie')
 .format('full')
```
Implementation of RequestBuilder.format
- Defined in RequestBuilder/RequestBuilderImpl.ts:218

orderby

orderby(field, direction?): RequestBuilder
Order the results by a specific attribute
Parameters
- field: string
  
  The attribute to order by
- direction: "asc" | "desc" = 'asc'
  
  The direction to order by (asc or desc)
Returns RequestBuilder
The RequestBuilderImpl
Example
```
new ODataRequest('Fractie')
  .orderby('NaamNL') // Direction defaults to asc
```
Example
```
new ODataRequest('Fractie')
  .orderby('NaamNL', 'asc')
```
Example
```
new ODataRequest('Fractie')
  .orderby('NaamNL', 'desc')
```
Implementation of RequestBuilder.orderby
- Defined in RequestBuilder/RequestBuilderImpl.ts:156

select

select(attribute): RequestBuilder
Select a specific attribute to return Will only show the attribute(s) selected for the entity
Parameters
- attribute: string
  
  The attribute to select
Returns RequestBuilder
The RequestBuilderImpl
Example
```
new ODataRequest('Fractie')
  // You can select multiple attributes
  .select('NaamNL')
  .select('NaamEN')
```
Example
```
new ODataRequest('Fractie')
 .select('NaamNL')
```
Implementation of RequestBuilder.select
- Defined in RequestBuilder/RequestBuilderImpl.ts:196

skip

skip(skip): RequestBuilder
Skip the first n results
Parameters
- skip: number
  
  The amount of results to skip (1..n)
Returns RequestBuilder
The RequestBuilderImpl
Example
```
new ODataRequest('Fractie')
 .skip(1)
```
Example
```
new ODataRequest('Fractie')
  .skip(250)
```
Implementation of RequestBuilder.skip
- Defined in RequestBuilder/RequestBuilderImpl.ts:128

top

top(top): RequestBuilder
Limit the amount of results returned
Parameters
- top: number
  
  The amount of results to return (1..250)
Returns RequestBuilder
The RequestBuilderImpl
Example
```
new ODataRequest('Fractie')
  .top(1)
```
Example
```
new ODataRequest('Fractie')
 .top(250)
```
Throws
Error if $Top is already defined

Throws
Error if $Top is less than or equal to 0

Throws
Error if $Top is greater than 250
Implementation of RequestBuilder.top
- Defined in RequestBuilder/RequestBuilderImpl.ts:112

Methods - Other

custom

custom(query): RequestBuilder
Use a custom query. Will overwrite all previously declared functions. And will directly use the given query. Functions declared after this function will also be ignored.
Parameters
- query: string
  
  The custom query to use
Returns RequestBuilder
The RequestBuilderImpl
Throws
Error if the query does not start with a '$'

Remarks
- Will ignore all previously declared functions
- Will ignore all functions declared after this function
Example
```
new ODataRequest('Fractie')
 .custom('$select=Afkorting')
 // https://gegevensmagazijn.tweedekamer.nl/OData/v4/2.0/Fractie?$select=Afkorting
```
Example
```
new ODataRequest('Fractie')
   .custom('$select=Afkorting&$top=1')
 // https://gegevensmagazijn.tweedekamer.nl/OData/v4/2.0/Fractie?$select=Afkorting&$top=1
```
Implementation of RequestBuilder.custom
- Defined in RequestBuilder/RequestBuilderImpl.ts:236

selectMultiple

selectMultiple(attributes): RequestBuilderImpl

Select multiple attributes to return Will only show the attribute(s) selected for the entity

Parameters

attributes: string[]

The attributes to select

Returns RequestBuilderImpl

The RequestBuilderImpl

Example

new ODataRequest('Fractie')
 .selectMultiple(['NaamNL', 'NaamEN'])
 // You can also use the select function multiple times
 .selectMultiple(['DatumActief', 'DatumInactief'])

Example

new ODataRequest('Fractie')
 .selectMultiple(['NaamNL', 'NaamEN'])
 // You can also use the selectMultiple function in combination with the select function
 .select('DatumActief')

setSelect

setSelect(attributes): RequestBuilder
Select a list of attributes to return Will overwrite any previous select functions
Parameters
- attributes: string[]
  
  The attributes to select
Returns RequestBuilder
The RequestBuilderImpl
Example
```
new ODataRequest('Fractie')
  .setSelect(['NaamNL', 'NaamEN'])
```
Implementation of RequestBuilder.setSelect
- Defined in RequestBuilder/RequestBuilderImpl.ts:187

Methods - Resolve functions

build

build(): string
Given the current state of the RequestBuilderImpl, build the request url according to functions provided

Returns string
The build request url
Example
```
const construction = new ODataRequest('Fractie')
   .expand('FractieZetel')
   .top(1)

// Log the request url (build)
console.log(construction.build());
```
Implementation of RequestBuilder.build
- Defined in RequestBuilder/RequestBuilderImpl.ts:246

request

request(): Promise<any>

Given the current state of the RequestBuilderImpl, build the request url according to functions provided and then utilize cross-fetch to make the request

Returns Promise<any>

The response from the request

See

cross-fetch - Fetch API implementation

Remarks

Function flow: request -> build -> fetch

Example

new ODataRequest('Fractie')
   .expand('FractieZetel')
   .expand('Stemming', '$select=Soort')
   .top(1)
   .request()
   // Log the data
   .then(data => console.log(data))
   .catch(err => console.warn(err))

Example

const construction = new ODataRequest('Fractie')
    .expand('FractieZetel')
    .expand('Stemming', '$select=Soort')
    .top(1)

construction.request().then((data) => {
   // Log the data
    console.log(data);
}).catch((error) => {
    console.warn(error);
});

Methods - Special functions

findById

findById(id): RequestBuilder
Experimental
Unique function to gather information on a specific entity instead of the entire collection
Parameters
- id: string
  
  The unique id of the entity
Returns RequestBuilder
The RequestBuilderImpl
Throws
If invalid query options are provided

Remarks
[!] Does not work with all other functions Query options $filter, $orderby, $count, $skip, and $top can be applied only on collections.

Example
```
new ODataRequest('Fractie')
  .findById('65129918-f256-4975-9da4-488da34d6695')
```
Implementation of RequestBuilder.findById
- Defined in RequestBuilder/RequestBuilderImpl.ts:92

Class RequestBuilderImplInternal

Description

See

Hierarchy

Implements

Index

Constructors

Properties - ODataOptions

Properties - Other

Methods - Advanced/Development functions

Methods - OData functions

Methods - Other

Methods - Resolve functions

Methods - Special functions

Constructors

constructor

Parameters

entity: string

Returns RequestBuilderImpl

Example

Properties - ODataOptions

Optional _count

Optional _expand

Optional _filter

Optional _format

Optional _orderby

_select

Optional _skip

Optional _top

Properties - Other

Optional _custom

_endpoint

Default

_entity

Optional _id

Methods - Advanced/Development functions

endpoint

Parameters

endpoint: string

Returns RequestBuilder

Example

Methods - OData functions

count

Parameters

count: boolean

Returns RequestBuilder

Example

Example

expand

Parameters

attribute: string

Optional func: string

Returns RequestBuilder

Example

Example

filter

Parameters

expression: string

Returns RequestBuilder

Example

Example

format

Parameters

format: "none" | "minimal" | "full"

Returns RequestBuilder

Example

Example

Example

orderby

Parameters

field: string

direction: "asc" | "desc" = 'asc'

Returns RequestBuilder

Example

Example

Example

select

Parameters

attribute: string

Returns RequestBuilder

Class RequestBuilderImpl`Internal`

`Optional` _count

`Optional` _expand

`Optional` _filter

`Optional` _format

`Optional` _orderby

`Optional` _skip

`Optional` _top

`Optional` _custom

`Optional` _id

`Optional` func: string