Module: blueprints
Variables
coreExtensions
• coreExtensions: Object
Type declaration
| Name | Type |
|---|---|
catchIf | {} |
context | {} |
find | {} |
forId | {} |
forInstance | {} |
forModel | {} |
forRelation | {} |
include | {} |
target | {} |
when | {} |
Defined in
src/blueprints/extensions/coreExtension.ts:14
crudExtensions
• crudExtensions: Object
Type declaration
| Name | Type |
|---|---|
all | {} |
cached | {} |
cachedOr | {} |
cachedOrFail | {} |
create | {} |
destroy | {} |
instanceData | {} |
none | {} |
one | {} |
oneOr | {} |
oneOrCurrent | {} |
oneOrFail | {} |
raw | {} |
save | {} |
update | {} |
Defined in
src/blueprints/extensions/crudExtension.ts:4
hooksExtensions
• hooksExtensions: Object
Type declaration
| Name | Type |
|---|---|
onError | {} |
onFinally | {} |
onRunning | {} |
onSuccess | {} |
Defined in
src/blueprints/extensions/hooksExtension.ts:3
httpExtensions
• httpExtensions: Object
Type declaration
| Name | Type |
|---|---|
abortSignal | {} |
makeDelete | {} |
makeGet | {} |
makePatch | {} |
makePost | {} |
makePut | {} |
makeRequest | {} |
param | {} |
Defined in
src/blueprints/extensions/httpExtension.ts:3
jsonApiExtensions
• jsonApiExtensions: Object
Type declaration
| Name | Type |
|---|---|
fields | {} |
fieldsFor | {} |
filterBy | {} |
paginate | {} |
sortBy | {} |
sortByAsc | {} |
sortByDesc | {} |
Defined in
src/blueprints/extensions/jsonApiExtension.ts:3
jsonApiStarterExtensions
• jsonApiStarterExtensions: Object
Type declaration
| Name | Type |
|---|---|
abortSignal | {} |
all | {} |
cached | {} |
cachedOr | {} |
cachedOrFail | {} |
catchIf | {} |
context | {} |
create | {} |
destroy | {} |
fields | {} |
fieldsFor | {} |
filterBy | {} |
find | {} |
forId | {} |
forInstance | {} |
forModel | {} |
forRelation | {} |
include | {} |
instanceData | {} |
makeDelete | {} |
makeGet | {} |
makePatch | {} |
makePost | {} |
makePut | {} |
makeRequest | {} |
none | {} |
onError | {} |
onFinally | {} |
onRunning | {} |
onSuccess | {} |
one | {} |
oneOr | {} |
oneOrCurrent | {} |
oneOrFail | {} |
paginate | {} |
param | {} |
raw | {} |
save | {} |
sortBy | {} |
sortByAsc | {} |
sortByDesc | {} |
target | {} |
update | {} |
when | {} |
Defined in
src/blueprints/extensions/starters/jsonApiStarterExtensions.ts:7
readExtensions
• readExtensions: Object
Type declaration
| Name | Type |
|---|---|
all | {} |
cached | {} |
cachedOr | {} |
cachedOrFail | {} |
none | {} |
one | {} |
oneOr | {} |
oneOrCurrent | {} |
oneOrFail | {} |
raw | {} |
Defined in
src/blueprints/extensions/readExtension.ts:3
restExtension
• restExtension: Object
Defined in
src/blueprints/extensions/restExtension.ts:1
restStarterExtensions
• restStarterExtensions: Object
Type declaration
| Name | Type |
|---|---|
abortSignal | {} |
all | {} |
cached | {} |
cachedOr | {} |
cachedOrFail | {} |
catchIf | {} |
context | {} |
create | {} |
destroy | {} |
find | {} |
forId | {} |
forInstance | {} |
forModel | {} |
forRelation | {} |
include | {} |
instanceData | {} |
makeDelete | {} |
makeGet | {} |
makePatch | {} |
makePost | {} |
makePut | {} |
makeRequest | {} |
none | {} |
onError | {} |
onFinally | {} |
onRunning | {} |
onSuccess | {} |
one | {} |
oneOr | {} |
oneOrCurrent | {} |
oneOrFail | {} |
param | {} |
raw | {} |
save | {} |
target | {} |
update | {} |
when | {} |
Defined in
src/blueprints/extensions/starters/restStarterExtensions.ts:6
writeExtensions
• writeExtensions: Object
Type declaration
| Name | Type |
|---|---|
create | {} |
destroy | {} |
instanceData | {} |
save | {} |
update | {} |
Defined in
src/blueprints/extensions/writeExtension.ts:3
Functions
appendJsonApiParams
▸ appendJsonApiParams(context): Promise<Dictionary>
Parameters
| Name | Type |
|---|---|
context | Object |
Returns
Promise<Dictionary>
Defined in
src/blueprints/jsonapi/appendJsonApiParams.ts:4
makeCache
▸ makeCache(config?): RefsCache
Make a default cache implementation.
Parameters
| Name | Type |
|---|---|
config? | RefsCacheConfig |
Returns
Defined in
src/blueprints/makeCache.ts:8
makeHttpClient
▸ makeHttpClient<Extension>(config?): Object
Create the dependencies and action factory to interact with any HTTP backend using a simple client.
Type parameters
| Name | Type |
|---|---|
Extension | extends Object = {} |
Parameters
| Name | Type |
|---|---|
config | Object |
config.baseURL? | string |
config.errorTransformers? | ErrorTransformer[] |
config.extensions? | Extension |
config.requestTransformers? | RequestTransformer[] |
config.responseTransformers? | ResponseTransformer[] |
Returns
Object
| Name | Type |
|---|---|
Action | ActionClass<{}, Extension> |
action | ActionMockableFactory<[], { adapter: HttpAdapter }, Extension> |
adapter | HttpAdapter |
withDependencies | <C>(action: Action<C>) => Promise<Action<Awaited<C> & { adapter: HttpAdapter }, {}>> |
Defined in
src/blueprints/http/makeHttpClient.ts:11
makeJsonApi
▸ makeJsonApi<Extension>(config?): Object
Create the dependencies and action factory to interact with a JSON:API backend.
Type parameters
| Name | Type |
|---|---|
Extension | extends Object = {} |
Parameters
| Name | Type |
|---|---|
config | Object |
config.baseURL? | string |
config.errorTransformers? | ErrorTransformer[] |
config.extensions? | Extension |
config.requestTransformers? | RequestTransformer[] |
config.responseTransformers? | ResponseTransformer[] |
Returns
Object
| Name | Type |
|---|---|
Action | ActionClass<{}, Extension> |
action | ActionMockableFactory<[], { adapter: HttpAdapter ; cache: RefsCache ; deserializer: JsonApiDeserializer ; registry: MapRegistry ; serializer: JsonApiSerializer }, Extension> |
adapter | HttpAdapter |
cache | RefsCache |
deserializer | JsonApiDeserializer |
registry | MapRegistry |
serializer | JsonApiSerializer |
withDependencies | <C>(action: Action<C>) => Promise<Action<Awaited<C> & { adapter: HttpAdapter ; cache: RefsCache ; deserializer: JsonApiDeserializer ; registry: MapRegistry ; serializer: JsonApiSerializer }, {}>> |
Defined in
src/blueprints/jsonapi/makeJsonApi.ts:23
makeJsonRest
▸ makeJsonRest<Extension>(config?): Object
Create the dependencies and action factory to interact with a JSON REST backend.
Type parameters
| Name | Type |
|---|---|
Extension | extends Object = {} |
Parameters
| Name | Type |
|---|---|
config | Object |
config.baseURL? | string |
config.errorTransformers? | ErrorTransformer[] |
config.extensions? | Extension |
config.requestTransformers? | RequestTransformer[] |
config.responseTransformers? | ResponseTransformer[] |
Returns
Object
| Name | Type |
|---|---|
Action | ActionClass<{}, Extension> |
action | ActionMockableFactory<[], { adapter: HttpAdapter ; cache: RefsCache ; deserializer: RestDeserializer ; registry: MapRegistry ; serializer: RestSerializer }, Extension> |
adapter | HttpAdapter |
cache | RefsCache |
deserializer | RestDeserializer |
registry | MapRegistry |
serializer | RestSerializer |
withDependencies | <C>(action: Action<C>) => Promise<Action<Awaited<C> & { adapter: HttpAdapter ; cache: RefsCache ; deserializer: RestDeserializer ; registry: MapRegistry ; serializer: RestSerializer }, {}>> |
Defined in
src/blueprints/rest/makeJsonRest.ts:22
makeRegistry
▸ makeRegistry(config?): MapRegistry
Make a default registry implementation.
Parameters
| Name | Type |
|---|---|
config? | MapRegistryConfig |
Returns
Defined in
src/blueprints/makeRegistry.ts:6