Class: JSONAPIURLBuilder
Constructors​
constructor​
• new JSONAPIURLBuilder(settings)
Parameters​
| Name | Type |
|---|---|
settings | JSONAPIURLBuilderSettings |
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:41
Properties​
host​
• Optional host: string
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:35
keyMap​
• Optional keyMap: RecordKeyMap
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:39
namespace​
• Optional namespace: string
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:36
serializer​
• Optional serializer: JSONAPISerializer
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:38
serializerFor​
• serializerFor: SerializerForFn<Serializer<unknown, unknown, unknown, unknown>>
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:37
Methods​
appendQueryParams​
â–¸ appendQueryParams(url, params): string
Parameters​
| Name | Type |
|---|---|
url | string |
params | Dict<string> |
Returns​
string
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:304
buildFieldsParam​
â–¸ buildFieldsParam(fieldsSpecifier, request?): Dict<string>
Parameters​
| Name | Type |
|---|---|
fieldsSpecifier | Dict<string | string[]> |
request? | RecordQueryRequest | RecordTransformRequest |
Returns​
Dict<string>
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:280
buildFilterParam​
â–¸ buildFilterParam(filters, request?): Dict<unknown>[]
Parameters​
| Name | Type |
|---|---|
filters | FilterSpecifier[] | Dict<unknown> |
request? | RecordQueryRequest | RecordTransformRequest |
Returns​
Dict<unknown>[]
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:134
buildIncludeParam​
â–¸ buildIncludeParam(includeSpecifier, request?): string
Parameters​
| Name | Type |
|---|---|
includeSpecifier | string | string[] | string[][] |
request? | RecordQueryRequest | RecordTransformRequest |
Returns​
string
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:261
buildPageParam​
â–¸ buildPageParam(pageSpecifier, request?): Dict<unknown>
Parameters​
| Name | Type |
|---|---|
pageSpecifier | PageSpecifier |
request? | RecordQueryRequest | RecordTransformRequest |
Returns​
Dict<unknown>
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:251
buildSortParam​
â–¸ buildSortParam(sortSpecifiers, request?): string
Parameters​
| Name | Type |
|---|---|
sortSpecifiers | string | (string | SortSpecifier)[] |
request? | RecordQueryRequest | RecordTransformRequest |
Returns​
string
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:215
relatedResourceURL​
â–¸ relatedResourceURL(type, id, relationship): string
Parameters​
| Name | Type |
|---|---|
type | string |
id | string |
relationship | string |
Returns​
string
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:127
resourceHost​
â–¸ resourceHost(type?): undefined | string
Parameters​
| Name | Type |
|---|---|
type? | string |
Returns​
undefined | string
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:60
resourceNamespace​
â–¸ resourceNamespace(type?): undefined | string
Parameters​
| Name | Type |
|---|---|
type? | string |
Returns​
undefined | string
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:55
resourcePath​
â–¸ resourcePath(type, id?): string
Parameters​
| Name | Type |
|---|---|
type | string |
id? | string |
Returns​
string
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:84
resourceRelationshipURL​
â–¸ resourceRelationshipURL(type, id, relationship): string
Parameters​
| Name | Type |
|---|---|
type | string |
id | string |
relationship | string |
Returns​
string
Defined in​
packages/@orbit/jsonapi/src/jsonapi-url-builder.ts:115
resourceURL​
â–¸ resourceURL(type, id?): string
Parameters​
| Name | Type |
|---|---|
type | string |
id? | string |
Returns​
string