Class FilterBy<Body>

Type parameters

Body

Hierarchy

FilterBy

Index

Constructors

constructor

Properties

Methods

Object literals

requestConfig

Constructors

constructor

new FilterBy(config: ContentClientConfigV2, contentClient: AxiosInstance): FilterBy

- Defined in src/lib/content/coordinators/FilterBy.ts:23
Parameters
- config: ContentClientConfigV2
- contentClient: AxiosInstance
Returns FilterBy

Properties

Private Readonly config

config: ContentClientConfigV2

Private Readonly contentClient

contentClient: AxiosInstance

Private Readonly filterByService

filterByService: FilterByImpl<Body> = new FilterByImpl(this.config,this.contentClient)

Static PARENT_PATH

PARENT_PATH: string = "/_meta/hierarchy/parentId"

Static SCHEMA_PATH

SCHEMA_PATH: string = "/_meta/schema"

Methods

filterBy

filterBy<T>(path: string, value: T): FilterBy<Body>

- Defined in src/lib/content/coordinators/FilterBy.ts:38
This function will help construct requests for filtering Content Items or Slots

Type parameters
- T
Parameters
- path: string
  
  json path to the property you wish to filter by e.g /_meta/schema
- value: T
  
  value you want to return matches for
Returns FilterBy<Body>

FilterBy<Body>

filterByContentType

filterByContentType(value: string): FilterBy<Body>

- Defined in src/lib/content/coordinators/FilterBy.ts:59
equivalent to:
```
 client.filterBy('/_meta/schema', contentTypeUri)
```
Parameters
- value: string
Returns FilterBy<Body>

FilterBy<Body>

filterByParentId

filterByParentId(value: string): FilterBy<Body>

- Defined in src/lib/content/coordinators/FilterBy.ts:76
Fetch content by parent id

equivalent to:
```
 client.filterBy('/_meta/hierarchy/parentId', id)
```
Parameters
- value: string
Returns FilterBy<Body>

FilterBy<Body>

page

page(size: number, cursor?: string): FilterBy<Body>
page(cursor: string): FilterBy<Body>

- Defined in src/lib/content/coordinators/FilterBy.ts:104
Set page size and page cursor

Parameters
- size: number
  
  page size maximum of 12
- Optional cursor: string
  
  an encoded string that points to the next page
Returns FilterBy<Body>
- Defined in src/lib/content/coordinators/FilterBy.ts:110
set page cursor

Parameters
- cursor: string
  
  an encoded string that points to the next page
Returns FilterBy<Body>

request

request(parameters?: RequestOptions): Promise<FilterByResponse<Body>>

- Defined in src/lib/content/coordinators/FilterBy.ts:140
Parameters
- Optional parameters: RequestOptions
  
  api options for response format
Returns Promise<FilterByResponse<Body>>

FilterBy<Body>

sortBy

sortBy(key: string, order: IOrder): FilterBy<Body>

- Defined in src/lib/content/coordinators/FilterBy.ts:89
Set sortable key based on schema trait:sortable

Parameters
- key: string
  
  key you wish to sort by
- order: IOrder
  
  order enum ASC, DESC
Returns FilterBy<Body>

FilterBy<Body>

Object literals

Private requestConfig

requestConfig: object

filterBy

filterBy: undefined[] = []

Generated using TypeDoc