LinkedDataAPI | link-lib

Hierarchy

Dispatcher
DeltaProcessor
- LinkedDataAPI

Implemented by

DataProcessor

Index

Properties

Methods

Properties

dispatch

dispatch: MiddlewareActionHandler

flush

flush: () => Quad[]

Process all queued deltas

note:: Be sure to assign a new buffer array before starting processing to prevent infinite loops.

Type declaration

- (): Quad[]
- Returns Quad[]

processDelta

processDelta: (delta: Quadruple[]) => Quad[]

Type declaration

- (delta: Quadruple[]): Quad[]
- Parameters
  - delta: Quadruple[]
  Returns Quad[]

queueDelta

queueDelta: (delta: Quadruple[], subjects: number[]) => void

Type declaration

- (delta: Quadruple[], subjects: number[]): void
- Parameters
  - delta: Quadruple[]
  - subjects: number[]
  Returns void

Methods

execActionByIRI

execActionByIRI(subject: NamedNode, dataTuple: DataTuple): Promise<LinkedActionResponse>

- Defined in src/LinkedDataAPI.ts:23
Parameters
- subject: NamedNode
- dataTuple: DataTuple
Returns Promise<LinkedActionResponse>

Private getEntities

getEntities(resources: ResourceQueueItem[]): Promise<Quad[]>

- Defined in src/LinkedDataAPI.ts:26
Parameters
- resources: ResourceQueueItem[]
Returns Promise<Quad[]>

getEntity

getEntity(iri: NamedNode, opts?: RDFFetchOpts): Promise<Quad[]>

- Defined in src/LinkedDataAPI.ts:37
Gets an entity by its SomeNode.

When data is already present for the SomeNode as a subject, the stored data is returned, otherwise the SomeNode will be fetched and processed.

Parameters
- iri: NamedNode
  
  The SomeNode of the resource
- Optional opts: RDFFetchOpts
  
  The options for fetch-/processing the resource.
Returns Promise<Quad[]>

A promise with the resulting entity

getStatus

getStatus(iri: SomeNode): EmptyRequestStatus | PendingRequestStatus | FulfilledRequestStatus

- Defined in src/LinkedDataAPI.ts:55
Retrieve the (network) status for a resource.

This API is still unstable, but only the latest status should be taken into account. So if a resource was successfully fetched at some point, but a retry failed, the result will be failed.

Some cases don't have proper HTTP status codes, but some (unstandardized) codes are very close.

Special errors:
- Resources which are still loading are given status 202 Accepted.
- Resources where fetching timed out are given status 408 - Request Timeout.
- Resources where fetching failed due to browser and OS errors are given status 499 - Client Closed Request.
- Resources which haven't been requested and aren't scheduled to be requested currently have no status code.
Parameters
- iri: SomeNode
  
  The resource to get the status on.
Returns EmptyRequestStatus | PendingRequestStatus | FulfilledRequestStatus

invalidate

invalidate(iri: string | SomeNode, error?: Error): boolean

- Defined in src/LinkedDataAPI.ts:58
unstable

Parameters
- iri: string | SomeNode
- Optional error: Error
Returns boolean

isInvalid

isInvalid(iri: SomeNode): boolean

- Defined in src/LinkedDataAPI.ts:61
unstable

Parameters
- iri: SomeNode
Returns boolean

registerTransformer

registerTransformer(processor: ResponseTransformer, mediaType: string | string[], acceptValue: number): void

- Defined in src/LinkedDataAPI.ts:64
Register a transformer so it can be used to interact with API's.

Parameters
- processor: ResponseTransformer
- mediaType: string | string[]
- acceptValue: number
Returns void

save

save(graph: SomeNode, opts: SaveOpts): Promise<void>

- Defined in src/LinkedDataAPI.ts:80
Save a {graph} to {graph} (identity) or {opts.url}.

When {graph} is a blank node {opts.url} must be given as well.

Parameters
- graph: SomeNode
- opts: SaveOpts
Returns Promise<void>

setAcceptForHost

setAcceptForHost(origin: string, acceptValue: string): void

- Defined in src/LinkedDataAPI.ts:87
Overrides the Accept value for when a certain host doesn't respond well to multiple values.

Parameters
- origin: string
  
  The iri of the origin for the requests.
- acceptValue: string
  
  The value to use for the Accept header.
Returns void

Generated using TypeDoc