ResourcePlugin

ResourcePlugin.

Classes

ResourcePlugableClass

Extends PlugableClass.

new ResourcePlugableClass(): ResourcePlugableClass

Returns ResourcePlugableClass. Inherited from PlugableClass.constructor.

Property	Type
`delete`	<`ARGS`>(`args`: `ARGS`, `opts`?: `JobOptions`) => `Promise`<`DataOrError`<`IfArray`<`ARGS`, `Identified`>>>
`functions`	`FunctionRecord`
`insert`	<`ARGS`>(`args`: `ARGS`, `opts`?: `JobOptions`) => `Promise`<`DataOrError`<`IfArray`<`ARGS`, `ResourceInsertResponse`>>>
`options`	`ResourcePluginOptions`
`row`	(`args`: `Identified`, `opts`?: `JobOptions`) => `Promise`<`DataOrError`<`StoredResource`>>
`select`	(`args`: `ResourceSearchRequest`, `opts`?: `JobOptions`) => `Promise`<`DataOrError`<`ResourceSearchResponse`>>
`update`	<`ARGS`>(`args`: `ARGS`, `opts`?: `JobOptions`) => `Promise`<`DataOrError`<`IfArray`<`ARGS`, `StoredResource`>>>

Methods

install(definition, …ids): void | Errored

Parameter	Type	Description
`definition`	`string` \| `Function` \| `StringTuple`
…`ids`	`string`[]

Returns void | Errored. Inherited from PlugableClass.install.

toString(): string

Returns string. Inherited from PlugableClass.toString.

Interfaces

DropResource

Extends Resource.

Property	Type
`bytes?`	`number`
`createdAt?`	`string`
`decoded?`	`UnknownRecord`
`id`	`string`
`label?`	`string`
`projectId?`	`string`
`request`	`EndpointRequest`
`source`	`DropType`
`type`	`ResourceType`
`updatedAt?`	`string`
`uploadedAt?`	`string`

RawStorableResource

Extends StorableResource.

Property	Type
`bytes?`	`number`
`createdAt?`	`string`
`decoded?`	`UnknownRecord`
`id?`	`string`
`label?`	`string`
`projectId?`	`string`
`request`	`EndpointObject`
`source`	`string`
`type`	`"raw"`
`updatedAt?`	`string`
`uploadedAt?`	`string`

Resource

Extends StoredResource. Extended by MediaResource and DropResource.

Property	Type
`bytes?`	`number`
`createdAt?`	`string`
`decoded?`	`UnknownRecord`
`id`	`string`
`label?`	`string`
`projectId?`	`string`
`request`	`EndpointRequest`
`source`	`string`
`type`	`ResourceType`
`updatedAt?`	`string`
`uploadedAt?`	`string`

ResourceInsertResponse

Property	Type
`fileProperty?`	`string`
`id`	`string`
`request`	`EndpointRequest`
`storeRequest?`	`EndpointRequest`

ResourcePluginOptions

Property	Type
`extensions`	`Record`<`DropType`, `OrArray`<`string`>>
`fileArg`	`string`
`fileName`	`string`
`includeIdInEndpoint?`	`boolean`
`includeUserInEndpoint?`	`boolean`
`uploadLimits`	`Record`<`DropType`, `number`>

ResourceSaveRequest

Extends StorableResource.

Property	Type
`bytes?`	`number`
`createdAt?`	`string`
`decoded?`	`UnknownRecord`
`id?`	`string`
`label?`	`string`
`projectId?`	`string`
`request`	`EndpointRequest`
`source`	`string`
`type`	`ResourceType`
`updatedAt?`	`string`
`uploadedAt?`	`string`

StorableResource

Extends Storable.StringIndexable. Extended by StorableDecode, StorableEncode, StoredResource, RawStorableResource, ResourceObject, ResourceSaveRequest, and StorableTranscode.

Property	Type
`bytes?`	`number`
`createdAt?`	`string`
`decoded?`	`UnknownRecord`
`id?`	`string`
`label?`	`string`
`projectId?`	`string`
`request`	`EndpointObject`
`source`	`string`
`type`	`ResourceType`
`updatedAt?`	`string`
`uploadedAt?`	`string`

StoredResource

Extends StorableResource. Extended by Resource.

Property	Type
`bytes?`	`number`
`createdAt?`	`string`
`decoded?`	`UnknownRecord`
`id`	`string`
`label?`	`string`
`projectId?`	`string`
`request`	`EndpointRequest`
`source`	`string`
`type`	`ResourceType`
`updatedAt?`	`string`
`uploadedAt?`	`string`

Variables

ResourcePlugin

const ResourcePlugin: ResourcePlugableClass

Functions

clientDeleteResourcePlug

clientDeleteResourcePlug<ARGS>(args, opts?): Promise<DataOrError<IfArray<ARGS, Identified>>>

Type Parameter	Description
`ARGS` extends `OrArray`<`Identified`>

Parameter	Type	Description
`args`	`ARGS`
`opts`?	`JobOptions`

Returns Promise<DataOrError<IfArray<ARGS, Identified>>>.

clientInsertResourcePlug

clientInsertResourcePlug<ARGS>(args, opts?): Promise<DataOrError<IfArray<ARGS, ResourceInsertResponse>>>

Type Parameter	Description
`ARGS` extends `OrArray`<`StorableResource`>

Parameter	Type	Description
`args`	`ARGS`
`opts`?	`JobOptions`

Returns Promise<DataOrError<IfArray<ARGS, ResourceInsertResponse>>>.

clientRowResourcePlug

clientRowResourcePlug(args, opts?): Promise<DataOrError<StoredResource>>

Parameter	Type	Description
`args`	`Identified`
`opts`?	`JobOptions`

Returns Promise<DataOrError<StoredResource>>.

clientSelectResourcePlug

clientSelectResourcePlug(args, opts?): Promise<DataOrError<ResourceSearchResponse>>

Parameter	Type	Description
`args`	`ResourceSearchRequest`
`opts`?	`JobOptions`

Returns Promise<DataOrError<ResourceSearchResponse>>.

clientUpdateResourcePlug

clientUpdateResourcePlug<ARGS>(args, opts?): Promise<DataOrError<IfArray<ARGS, StoredResource>>>

Type Parameter	Description
`ARGS` extends `OrArray`<`StoredResource`>

Parameter	Type	Description
`args`	`ARGS`
`opts`?	`JobOptions`

Returns Promise<DataOrError<IfArray<ARGS, StoredResource>>>.

copyResource

copyResource(resource): ResourceObject

Parameter	Type
`resource`	`Resource`

Returns ResourceObject.

isMediaResource

isMediaResource(value): value is MediaResource

Parameter	Type
`value`	`any`

Returns value is MediaResource.

isRawStorableResource

isRawStorableResource(value): value is RawStorableResource

Parameter	Type
`value`	`any`

Returns value is RawStorableResource.

isResource

isResource(value): value is Resource

Parameter	Type
`value`	`any`

Returns value is Resource.

isStorableResource

isStorableResource(value): value is StorableResource

Parameter	Type
`value`	`any`

Returns value is StorableResource.

isStoredResource

isStoredResource(value): value is StoredResource

Parameter	Type
`value`	`any`

Returns value is StoredResource.

serverDeleteResourcePlug

serverDeleteResourcePlug<ARGS>(args, opts?): Promise<DataOrError<IfArray<ARGS, Identified>>>

Type Parameter	Description
`ARGS` extends `OrArray`<`Identified`>

Parameter	Type	Description
`args`	`ARGS`
`opts`?	`JobOptions`

Returns Promise<DataOrError<IfArray<ARGS, Identified>>>.

serverInsertResourcePlug

serverInsertResourcePlug<ARGS>(args, opts?): Promise<DataOrError<IfArray<ARGS, ResourceInsertResponse>>>

Type Parameter	Description
`ARGS` extends `OrArray`<`StorableResource`>

Parameter	Type	Description
`args`	`ARGS`
`opts`?	`JobOptions`

Returns Promise<DataOrError<IfArray<ARGS, ResourceInsertResponse>>>.

serverRowResourcePlug

serverRowResourcePlug(args, opts?): Promise<DataOrError<StoredResource>>

Parameter	Type	Description
`args`	`Identified`
`opts`?	`JobOptions`

Returns Promise<DataOrError<StoredResource>>.

serverSelectResourcePlug

serverSelectResourcePlug(args, opts?): Promise<DataOrError<ResourceSearchResponse>>

Parameter	Type	Description
`args`	`ResourceSearchRequest`
`opts`?	`JobOptions`

Returns Promise<DataOrError<ResourceSearchResponse>>.

serverUpdateResourcePlug

serverUpdateResourcePlug<ARGS>(args, opts?): Promise<DataOrError<IfArray<ARGS, StoredResource>>>

Type Parameter	Description
`ARGS` extends `OrArray`<`StoredResource`>

Parameter	Type	Description
`args`	`ARGS`
`opts`?	`JobOptions`

Returns Promise<DataOrError<IfArray<ARGS, StoredResource>>>.