Class Resource

Describes an Atomic Resource, which has a Subject URL and a bunch of Property / Value combinations.

Hierarchy

Resource

Index

Constructors

constructor

new Resource(subject: string, newResource?: boolean): Resource
Parameters
- subject: string
- Optional newResource: boolean
Returns Resource
- Defined in lib/src/resource.ts:50

Properties

appliedCommitSignatures

appliedCommitSignatures: Set<string>

Every commit that has been applied should be stored here, which prevents applying the same commit twice

`Private` commitBuilder

commitBuilder: CommitBuilder

`Optional` commitError

commitError?: Error

If the commit could not be saved, we put that info here.

`Optional` error

error?: Error

If the resource could not be fetched, we put that info here.

loading

loading: boolean

Is true when the Resource is currently being fetched, awaiting a response from the Server

new

new: boolean

Is true for locally created, unsaved resources

`Private` propvals

propvals: PropVals

`Private` subject

subject: string

Accessors

title

get title(): JSONPrimitive | JSONObject | JSONArray
Returns JSONPrimitive | JSONObject | JSONArray
- Defined in lib/src/resource.ts:65

Methods

canWrite

canWrite(store: Store, agent?: string, child?: string): Promise<[boolean, undefined | string]>
Checks if the agent has write rights by traversing the graph. Recursive function.
Parameters
- store: Store
- Optional agent: string
- Optional child: string
Returns Promise<[boolean, undefined | string]>
- Defined in lib/src/resource.ts:75

clone

clone(): Resource
Creates a clone of the Resource, which makes sure the reference is different from the previous one. This can be useful when doing reference compares.

Returns Resource
- Defined in lib/src/resource.ts:122

destroy

destroy(store: Store, agent?: Agent): Promise<void>
Removes the resource form both the server and locally
Parameters
- store: Store
- Optional agent: Agent
Returns Promise<void>
- Defined in lib/src/resource.ts:264

get

get(propUrl: string): JSONValue
Get a Value by its property
Parameters
- propUrl: string
Returns JSONValue
- Defined in lib/src/resource.ts:142

getArray

getArray(propUrl: string): JSONArray
Get a Value by its property, returns as Array or throws error. Returns empty array if there is no value
Parameters
- propUrl: string
Returns JSONArray
- Defined in lib/src/resource.ts:162

getChildrenCollection

getChildrenCollection(): string
Returns the subject of the list of Children

Returns string
- Defined in lib/src/resource.ts:189

getClasses

getClasses(): string[]
Get a Value by its property

Returns string[]
- Defined in lib/src/resource.ts:169

getCommitBuilder

getCommitBuilder(): CommitBuilder
Returns the current Commit Builder, which describes the pending changes of the resource

Returns CommitBuilder
- Defined in lib/src/resource.ts:184

getPropVals

getPropVals(): PropVals
Returns the internal Map of Property-Values

Returns PropVals
- Defined in lib/src/resource.ts:214

getRights

getRights(store: Store): Promise<Right[]>
Iterates over the parents of the resource, returns who has read / write rights for this resource
Parameters
- store: Store
Returns Promise<Right[]>
- Defined in lib/src/resource.ts:222

getSubject

getSubject(): string
Returns the subject URL of the Resource

Returns string
- Defined in lib/src/resource.ts:202

getSubjectNoParams

getSubjectNoParams(): string
Returns the subject URL of the Resource

Returns string
- Defined in lib/src/resource.ts:207

getSubjects

getSubjects(propUrl: string): string[]
Get a Value by its property, returns as Array with subjects instead of the full resource or throws error. Returns empty array if there is no value
Parameters
- propUrl: string
Returns string[]
- Defined in lib/src/resource.ts:150

hasClasses

hasClasses(...classSubjects: string[]): boolean
Checks if the resource is all of the given classes
Parameters
- Rest ...classSubjects: string[]
Returns boolean
- Defined in lib/src/resource.ts:174

isReady

isReady(): boolean
Checks if the resource is both loaded and free from errors

Returns boolean
- Defined in lib/src/resource.ts:137

isUnauthorized

isUnauthorized(): boolean
Returns true is the resource had an Unauthorized 401 response.

Returns boolean
- Defined in lib/src/resource.ts:259

pushPropVal

pushPropVal(propUrl: string, ...values: JSONArray): void
Appends a Resource to a ResourceArray
Parameters
- propUrl: string
- Rest ...values: JSONArray
Returns void
- Defined in lib/src/resource.ts:285

removePropVal

removePropVal(propertyUrl: string): void
Removes a property value combination from the resource and adds it to the next Commit
Parameters
- propertyUrl: string
Returns void
- Defined in lib/src/resource.ts:293

removePropValLocally

removePropValLocally(propertyUrl: string): void
Removes a property value combination from this resource, does not store the remove action in Commit
Parameters
- propertyUrl: string
Returns void
- Defined in lib/src/resource.ts:305

save

save(store: Store, differentAgent?: Agent): Promise<string>
Commits the changes and sends the Commit to the resource's /commit endpoint. Returns the Url of the created Commit. If you don't pass an Agent explicitly, the default Agent of the Store is used.
Parameters
- store: Store
- Optional differentAgent: Agent
Returns Promise<string>
- Defined in lib/src/resource.ts:314

set

set(prop: string, value: JSONValue, store: Store, validate?: boolean): Promise<void>
Set a Property, Value combination and perform a validation. Will throw if property is not valid for the datatype. Will fetch the datatype if it's not available. Adds the property to the commitbuilder.
Parameters
- prop: string
- value: JSONValue
- store: Store
- validate: boolean = true
  
  Disable validation if you don't need it. It might cause a fetch if the Property is not present when set is called
Returns Promise<void>
- Defined in lib/src/resource.ts:396

setError

setError(e: Error): void
Sets the error on the Resource. Does not Throw.
Parameters
- e: Error
Returns void
- Defined in lib/src/resource.ts:430

setSubject

setSubject(subject: string): void
Set the Subject / ID URL of the Resource. Does not update the Store.
Parameters
- subject: string
Returns void
- Defined in lib/src/resource.ts:435

setUnsafe

setUnsafe(prop: string, val: JSONValue): void
Set a Property, Value combination without performing validations or adding it to the CommitBuilder.
Parameters
- prop: string
- val: JSONValue
Returns void
- Defined in lib/src/resource.ts:425

Class Resource

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

subject: string

Optional newResource: boolean

Returns Resource

Properties

appliedCommitSignatures

Private commitBuilder

Optional commitError

Optional error

loading

new

Private propvals

Private subject

Accessors

title

Returns JSONPrimitive | JSONObject | JSONArray

Methods

canWrite

Parameters

store: Store

Optional agent: string

Optional child: string

Returns Promise<[boolean, undefined | string]>

clone

Returns Resource

destroy

Parameters

store: Store

Optional agent: Agent

Returns Promise<void>

get

Parameters

propUrl: string

Returns JSONValue

getArray

Parameters

propUrl: string

Returns JSONArray

getChildrenCollection

Returns string

getClasses

Returns string[]

getCommitBuilder

Returns CommitBuilder

getPropVals

Returns PropVals

getRights

Parameters

store: Store

Returns Promise<Right[]>

getSubject

Returns string

getSubjectNoParams

Returns string

getSubjects

Parameters

propUrl: string

Returns string[]

hasClasses

Parameters

Rest ...classSubjects: string[]

Returns boolean

isReady

Returns boolean

isUnauthorized

Returns boolean

pushPropVal

Parameters

propUrl: string

Rest ...values: JSONArray

Returns void

`Optional` newResource: boolean

`Private` commitBuilder

`Optional` commitError

`Optional` error

`Private` propvals

`Private` subject

`Optional` agent: string

`Optional` child: string

`Optional` agent: Agent

`Rest` ...classSubjects: string[]

`Rest` ...values: JSONArray

`Optional` differentAgent: Agent