Class Resource<C>

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

Type Parameters

C extends OptionalClass = any

Hierarchy

Resource

Constructors

constructor

new Resource<C>(subject: string, newResource?: boolean): Resource<C>
Type Parameters
- C extends OptionalClass = any
Parameters
- subject: string
- Optional newResource: boolean
Returns Resource<C>
- Defined in lib/src/resource.ts:66

Properties

`Readonly` __internalObject

__internalObject: Resource<C> = ...

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.

`Private` hasQueue

hasQueue: boolean = false

`Private` inProgressCommit

inProgressCommit: undefined | Promise<void>

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

props

get props(): QuickAccesPropType<C>
Returns QuickAccesPropType<C>
- Defined in lib/src/resource.ts:88

title

get title(): string
Returns string
- Defined in lib/src/resource.ts:81

Methods

addClasses

addClasses(store: Store, ...classSubject: string[]): Promise<void>
Adds the given classes to the resource
Parameters
- store: Store
- Rest ...classSubject: string[]
Returns Promise<void>
- Defined in lib/src/resource.ts:263

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:142

clone

clone(): Resource<C>
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<C>
- Defined in lib/src/resource.ts:189

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:388

equals

equals(resourceB: Resource<any>): boolean
Checks if the content of two Resource instances is equal
Parameters
- resourceB: Resource<any>
Returns boolean
- Defined in lib/src/resource.ts:103

`Private` equalsCurrentValue

equalsCurrentValue(prop: string, value: JSONValue): boolean
Returns true if the value has not changed
Parameters
- prop: string
- value: JSONValue
Returns boolean
- Defined in lib/src/resource.ts:650

get

get<Prop, Returns>(propUrl: Prop): Returns
Get a Value by its property
Type Parameters
- Prop extends string
- Returns = Prop extends keyof PropTypeMapping ? Prop extends Requires<C> ? PropTypeMapping[Prop] : Prop extends Recommends<C> ? undefined | PropTypeMapping[Prop] : undefined | PropTypeMapping[Prop] : JSONValue
Parameters
- propUrl: Prop
Returns Returns
- Defined in lib/src/resource.ts:208

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:230

getChildrenCollection

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

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

getClasses

getClasses(): string[]
Returns a list of classes of this resource

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

getCommitsCollection

getCommitsCollection(): string
Returns string
- Defined in lib/src/resource.ts:274

getHistory

getHistory(store: Store): Promise<Version[]>
builds all versions using the Commits
Parameters
- store: Store
Returns Promise<Version[]>
- Defined in lib/src/resource.ts:298

getPropVals

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

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

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:346

getSubject

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

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

getSubjectNoParams

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

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

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:218

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:242

hasUnsavedChanges

hasUnsavedChanges(): boolean
Returns true if the resource has changes in it's commit builder that are not yet saved to the server.

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

`Private` isParentNew

isParentNew(store: Store): boolean
Parameters
- store: Store
Returns boolean
- Defined in lib/src/resource.ts:660

isReady

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

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

isUnauthorized

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

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

pushPropVal

pushPropVal(propUrl: string, values: JSONArray, unique?: boolean): void
Appends a Resource to a ResourceArray
Parameters
- propUrl: string
- values: JSONArray
- Optional unique: boolean
Returns void
- Defined in lib/src/resource.ts:415

removeClasses

removeClasses(store: Store, ...classSubjects: string[]): Promise<void>
Remove the given classes from the resource
Parameters
- store: Store
- Rest ...classSubjects: string[]
Returns Promise<void>
- Defined in lib/src/resource.ts:249

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:435

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:447

save

save(store: Store, differentAgent?: Agent): Promise<undefined | 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. When there are no changes no commit is made and the function returns Promise.
Parameters
- store: Store
- Optional differentAgent: Agent
Returns Promise<undefined | string>
- Defined in lib/src/resource.ts:457

set

set<Prop, Value>(prop: Prop, value: Value, 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.

When undefined is passed as value, the property is removed from the resource.
Type Parameters
- Prop extends string
- Value extends JSONValue
Parameters
- prop: Prop
- value: Value
- 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:590

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:638

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:643

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:633

Class Resource<C>

Type Parameters

C extends OptionalClass = any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

C extends OptionalClass = any

Parameters

subject: string

Optional newResource: boolean

Returns Resource<C>

Properties

Readonly __internalObject

appliedCommitSignatures

Private commitBuilder

Optional commitError

Optional error

Private hasQueue

Private inProgressCommit

loading

new

Private propvals

Private subject

Accessors

props

Returns QuickAccesPropType<C>

title

Returns string

Methods

addClasses

Parameters

store: Store

Rest ...classSubject: string[]

Returns Promise<void>

canWrite

Parameters

store: Store

Optional agent: string

Optional child: string

Returns Promise<[boolean, undefined | string]>

clone

Returns Resource<C>

destroy

Parameters

store: Store

Optional agent: Agent

Returns Promise<void>

equals

Parameters

resourceB: Resource<any>

Returns boolean

Private equalsCurrentValue

Parameters

prop: string

value: JSONValue

Returns boolean

get

Type Parameters

Prop extends string

Returns = Prop extends keyof PropTypeMapping ? Prop extends Requires<C> ? PropTypeMapping[Prop] : Prop extends Recommends<C> ? undefined | PropTypeMapping[Prop] : undefined | PropTypeMapping[Prop] : JSONValue

Parameters

propUrl: Prop

Returns Returns

getArray

Parameters

propUrl: string

Returns JSONArray

getChildrenCollection

Returns string

getClasses

Returns string[]

getCommitsCollection

Returns string

getHistory

`Optional` newResource: boolean

`Readonly` __internalObject

`Private` commitBuilder

`Optional` commitError

`Optional` error

`Private` hasQueue

`Private` inProgressCommit

`Private` propvals

`Private` subject

`Rest` ...classSubject: string[]

`Optional` agent: string

`Optional` child: string

`Optional` agent: Agent

`Private` equalsCurrentValue

`Rest` ...classSubjects: string[]

`Private` isParentNew

`Optional` unique: boolean

`Rest` ...classSubjects: string[]

`Optional` differentAgent: Agent