IGraph | @stoplight/graphite

Graph

Type parameters

N
E

Hierarchy

Index

Properties

Methods

Properties

addEdge

addEdge: function

Type declaration

- (sourceId: string, targetId: string, type: EdgeType, data?: unknown, trace?: ITraceData): EdgeInstance
- Parameters
  - sourceId: string
  - targetId: string
  - type: EdgeType
  - Optional data: unknown
  - Optional trace: ITraceData
  Returns EdgeInstance

addNode

addNode: function

Type declaration

- <NodeType>(props: NodeType, trace?: ITraceData): NodeInstance
- Type parameters
  - NodeType: NodeWithOptionalId
  Parameters
  - props: NodeType
  - Optional trace: ITraceData
  Returns NodeInstance

applyPatch

applyPatch: function

Type declaration

- (patch: IGraphPatch): IGraphPatchResult
- Parameters
  - patch: IGraphPatch
  Returns IGraphPatchResult

dehydrate

dehydrate: function

Type declaration

- (): IDehydratedGraph
- Returns IDehydratedGraph

dom

dom: IGraphDom<N, E>

moveNode

moveNode: function

Type declaration

- (id: string, newParentId?: string | null, newPath?: undefined | string, trace?: ITraceData): void
- Parameters
  - id: string
  - Optional newParentId: string | null
  - Optional newPath: undefined | string
  - Optional trace: ITraceData
  Returns void

nodeValues

nodeValues: NodeInstance[]

notifier

notifier: INotifier

patchSourceNodeProp

patchSourceNodeProp: function

Type declaration

- (id: string, prop: SourceNodeProp, patch: JsonPatch, trace?: ITraceData): void
- Parameters
  - id: string
  - prop: SourceNodeProp
  - patch: JsonPatch
  - Optional trace: ITraceData
  Returns void

printTree

printTree: function

Type declaration

- (): string
- Returns string

removeEdge

removeEdge: function

Type declaration

- (id: string, trace?: ITraceData): void
- Parameters
  - id: string
  - Optional trace: ITraceData
  Returns void

removeNode

removeNode: function

Type declaration

- (id: string, trace?: ITraceData): void
- Parameters
  - id: string
  - Optional trace: ITraceData
  Returns void

reportError

reportError: function

Type declaration

- (nodeId: string, err: ErrnoException, trace?: ITraceData): void
- Parameters
  - nodeId: string
  - err: ErrnoException
  - Optional trace: ITraceData
  Returns void

rootNodes

rootNodes: ISourceNodeInstance[]

setSourceNodeDiagnostics

setSourceNodeDiagnostics: function

Type declaration

- (id: string, source: string, value: IDiagnostic[], trace?: ITraceData): void
- Parameters
  - id: string
  - source: string
  - value: IDiagnostic[]
  - Optional trace: ITraceData
  Returns void

setSourceNodeProp

setSourceNodeProp: function

Type declaration

- (id: string, prop: SourceNodeProp, value: unknown, trace?: ITraceData): void
- Parameters
  - id: string
  - prop: SourceNodeProp
  - value: unknown
  - Optional trace: ITraceData
  Returns void

sourceNodes

sourceNodes: ISourceNodeInstance[]

virtualNodes

virtualNodes: IVirtualNodeInstance[]

Methods

dispose

dispose(): void

Inherited from IDisposable.dispose
- Defined in /home/circleci/project/node_modules/@stoplight/lifecycle/disposable/types.d.ts:2
Returns void

getNodeById

getNodeById(id: string): Optional<NodeInstance>

Inherited from INodeFinder.getNodeById
- Defined in graph/dom/types.ts:18
Parameters
- id: string
Returns Optional<NodeInstance>

getNodeByUri

getNodeByUri(uri: string): Optional<NodeInstance>

Inherited from INodeFinder.getNodeByUri
- Defined in graph/dom/types.ts:19
Parameters
- uri: string
Returns Optional<NodeInstance>