Tripledoc

Tripledoc

  • Docs
  • API reference
  • Cheatsheet

›Introduction

Introduction

  • Globals

Interfaces

  • LocalTripleDocumentForContainer
  • LocalTripleDocumentWithRef
  • TripleDocument
  • TripleSubject

tripledoc - v4.4.0

Globals

Index

Interfaces

  • LocalTripleDocumentForContainer
  • LocalTripleDocumentWithRef
  • TripleDocument
  • TripleSubject

Type aliases

  • LiteralTypes
  • Reference

Functions

  • createDocument
  • createDocumentInContainer
  • fetchDocument

Type aliases

LiteralTypes

Ƭ LiteralTypes: string | number | Date

Literal values, i.e. values that do not point to other nodes in the Linked Data graph.


Reference

Ƭ Reference: string

A URL that points to a node in the Linked Data graph.

Functions

createDocument

▸ createDocument(ref: Reference): LocalTripleDocumentWithRef

Initialise a new Turtle document

Note that this Document will not be created on the Pod until you call save on it.

Parameters:

NameTypeDescription
refReferenceURL where this document should live

Returns: LocalTripleDocumentWithRef


createDocumentInContainer

▸ createDocumentInContainer(containerRef: Reference): LocalTripleDocumentForContainer

Initialise a new Turtle Document in a Container

Note that this Document will not be created on the Pod until you call save on it.

Parameters:

NameTypeDescription
containerRefReferenceURL of the Container in which this document should live

Returns: LocalTripleDocumentForContainer


fetchDocument

▸ fetchDocument(uri: Reference): Promise‹TripleDocument›

Retrieve a document containing RDF triples

Parameters:

NameType
uriReference

Returns: Promise‹TripleDocument›

Representation of triples in the document at uri.

LocalTripleDocumentForContainer →
  • Index
    • Interfaces
    • Type aliases
    • Functions
  • Type aliases
    • LiteralTypes
    • Reference
  • Functions
    • createDocument
    • createDocumentInContainer
    • fetchDocument
Tripledoc
Docs
Writing a Solid AppAPI ReferenceCheatsheet
More
Source codeRelease notes
Copyright © 2021 Inrupt