Class EndpointList

Hierarchy

EndpointList

Index

Constructors

constructor

Properties

_endpoints

Methods

Constructors

constructor

new EndpointList(...endpoints: Endpoint[]): EndpointList

- Defined in src/core/Endpoint.ts:66
List of endpoints with specific methods

Parameters
- Rest ...endpoints: Endpoint[]
  Endpoints
```
const endpoints = new EndpointList(endpoint1, endpoint2, ...)
```
Returns EndpointList

Properties

Private _endpoints

_endpoints: Endpoint[]

Methods

add

add(endpoint: Endpoint): void

- Defined in src/core/Endpoint.ts:88
Add an endpoint to the endpoint list

Parameters
- endpoint: Endpoint
  Endpoint to add
```
add(myEndpoint)
```
Returns void

addMany

addMany(endpoints: Endpoint[]): void

- Defined in src/core/Endpoint.ts:100
Add multiple endpoints to the endpoint list

Parameters
- endpoints: Endpoint[]
  Endpoints to add
```
addMany([ endpoint1, endpoint2, ... ])
```
Returns void

find

find(selector: { path: string; type?: EndpointType }): Endpoint[]

- Defined in src/core/Endpoint.ts:132
Find matching endpoints for the selection

Parameters
- selector: { path: string; type?: EndpointType }
  
  Path that has to match the endpoint and (facultative) type of the endpoint
  - path: string
  - Optional type?: EndpointType
Returns Endpoint[]

All the matching endpoints
```
const path = '/userLogin?username=...&password=...'
const endpoint = EndpointList.find({ path, type: 'HTTP' })
```

Static isPathMatching

isPathMatching(endpoint: Endpoint, path: string): boolean

- Defined in src/core/Endpoint.ts:117
Checks if the given path matchs the given endpoint

Parameters
- endpoint: Endpoint
  
  Endpoint to check
- path: string
  
  Path to check
Returns boolean

True if the path matchs the endpoint
```
const endpoint = ...
const path = '/userLogin?username=...&password=...'

const doesMatch = EndpointList.isPathMatching(endpoint, path)
```

Generated using TypeDoc