abstractASharedResource <T>

Hierarchy

• AResource<T>
  • ASharedResource

Index

Properties

• NODE_NAME
• NODE_TYPE
• properties
• resourceId
• response

Methods

• addChild
• addRelationship
• diff
• diffInverse
• diffProperties
• findParentsByProperty
• getAncestors
• getBoundaryMembers
• getChild
• getChildren
• getContext
• getDependencies
• getDependency
• getDependencyIndex
• getParents
• getSharedResource
• getSiblings
• hasAncestor
• isMarkedDeleted
• merge
• remove
• removeDependency
• removeRelationship
• setContext
• synth
• unSynth

Properties

abstractreadonlyNODE_NAME

NODE_NAME: string

Inherited from AResource.NODE_NAME

readonlyNODE_TYPE

NODE_TYPE: NodeType = NodeType.SHARED_RESOURCE

Overrides AResource.NODE_TYPE

readonlyproperties

properties: {}

Inherited from AResource.properties

Type declaration

• [key string]: unknown

readonlyresourceId

resourceId: string

Inherited from AResource.resourceId

readonlyresponse

response: {} = {}

Inherited from AResource.response

Type declaration

• [key string]: unknown

Methods

addChild

• addChild(onField: string | keyof T, child: UnknownNode, toField: string): { childToParentDependency: Dependency; parentToChildDependency: Dependency }

• Inherited from AResource.addChild

  Parameters

  • onField: string | keyof T

  • child: UnknownNode

  • toField: string

  Returns { childToParentDependency: Dependency; parentToChildDependency: Dependency }

  • childToParentDependency: Dependency

  • parentToChildDependency: Dependency

addRelationship

• addRelationship(): { thatToThisDependency: Dependency; thisToThatDependency: Dependency }

• Inherited from AResource.addRelationship

  Returns { thatToThisDependency: Dependency; thisToThatDependency: Dependency }

  • thatToThisDependency: Dependency

  • thisToThatDependency: Dependency

diff

• diff(): Promise<Diff[]>

• Overrides AResource.diff

  Returns Promise<Diff[]>

diffInverse

• diffInverse(diff: Diff, deReferenceResource: (resourceId: string) => Promise<UnknownResource>): Promise<void>

• Inherited from AResource.diffInverse

  Parameters

  • diff: Diff

  • deReferenceResource: (resourceId: string) => Promise<UnknownResource>

  Returns Promise<void>

diffProperties

• diffProperties(previous: ASharedResource<T> | T): Promise<Diff[]>

• Inherited from AResource.diffProperties

  Parameters

  • previous: ASharedResource<T> | T

  Returns Promise<Diff[]>

findParentsByProperty

• findParentsByProperty(filters: { key: string | number; value: any }[]): AResource<T>[]

• Parameters

  • filters: { key: string | number; value: any }[]

  Returns AResource<T>[]

getAncestors

• getAncestors(): UnknownNode[]

• Inherited from AResource.getAncestors

  Returns UnknownNode[]

getBoundaryMembers

• getBoundaryMembers(): UnknownNode[]

• Inherited from AResource.getBoundaryMembers

  Returns UnknownNode[]

getChild

• getChild(name: string, filters?: { key: string; value: any }[]): undefined | UnknownNode

• Inherited from AResource.getChild

  Parameters

  • name: string

  • filters: { key: string; value: any }[] = []

  Returns undefined | UnknownNode

getChildren

• getChildren(name?: string): {}

• Inherited from AResource.getChildren

  Parameters

  • optionalname: string

  Returns {}

  • [key string]: Dependency[]

getContext

• getContext(): string

• Inherited from AResource.getContext

  Returns string

getDependencies

• getDependencies(to?: UnknownNode): Dependency[]

• Inherited from AResource.getDependencies

  Parameters

  • optionalto: UnknownNode

  Returns Dependency[]

getDependency

• getDependency(to: UnknownNode, relationship: DependencyRelationship): undefined | Dependency

• Inherited from AResource.getDependency

  Parameters

  • to: UnknownNode

  • relationship: DependencyRelationship

  Returns undefined | Dependency

getDependencyIndex

• getDependencyIndex(to: UnknownNode, relationship: DependencyRelationship): number

• Inherited from AResource.getDependencyIndex

  Parameters

  • to: UnknownNode

  • relationship: DependencyRelationship

  Returns number

getParents

• getParents(name?: string): {}

• Inherited from AResource.getParents

  Parameters

  • optionalname: string

  Returns {}

  • [key string]: Dependency[]

getSharedResource

• getSharedResource(): undefined | ASharedResource<T>

• Overrides AResource.getSharedResource

  Returns undefined | ASharedResource<T>

getSiblings

• getSiblings(name?: string): {}

• Inherited from AResource.getSiblings

  Parameters

  • optionalname: string

  Returns {}

  • [key string]: Dependency[]

hasAncestor

• hasAncestor(node: UnknownNode): boolean

• Inherited from AResource.hasAncestor

  Parameters

  • node: UnknownNode

  Returns boolean

isMarkedDeleted

• isMarkedDeleted(): boolean

• Inherited from AResource.isMarkedDeleted

  To check if self is marked as deleted. A deleted node will be removed from the graph after the transaction.

  ---

  Returns boolean

merge

• merge(previousSharedResource: ASharedResource<T>): ASharedResource<T>

• Parameters

  • previousSharedResource: ASharedResource<T>

  Returns ASharedResource<T>

remove

• remove(): void

• Inherited from AResource.remove

  To mark self as deleted. A deleted node will be removed from the graph after the transaction.

  • A node cannot be deleted if it has dependencies.

  @throws

  Error If node contains dependencies to other nodes.

  ---

  Returns void

removeDependency

• removeDependency(dependencyIndex: number): void

• Inherited from AResource.removeDependency

  Parameters

  • dependencyIndex: number

  Returns void

removeRelationship

• removeRelationship(node: UnknownNode): void

• Inherited from AResource.removeRelationship

  Parameters

  • node: UnknownNode

  Returns void

setContext

• setContext(): string

• Inherited from AResource.setContext

  Returns string

synth

• synth(): IResource

• Inherited from AResource.synth

  Returns IResource

staticunSynth

• unSynth(deserializationClass: any, resource: IResource, parentResourceIds: string[], deReferenceResource: (resourceId: string) => Promise<UnknownResource>): Promise<UnknownResource>

• Inherited from AResource.unSynth

  Parameters

  • deserializationClass: any

  • resource: IResource

  • parentResourceIds: string[]

  • deReferenceResource: (resourceId: string) => Promise<UnknownResource>

  Returns Promise<UnknownResource>