Class: ObjectRef

TypeScript SDK reference

weave / ObjectRef

Represents a reference to a saved Weave object.

Generally, end users will not need to interact with this class directly.

An ObjectRef contains the project ID, object ID, and digest that uniquely identify a saved object in Weave’s storage system.

Example

const ref = new ObjectRef('my-project', 'abc123', 'def456');
const uri = ref.uri(); // weave:///my-project/object/abc123:def456

Table of contents

Constructors

• constructor

Properties

• digest
• objectId
• projectId

Methods

• get
• ui_url
• uri
• fromUri

Constructors

constructor

• new ObjectRef(projectId, objectId, digest): ObjectRef

Parameters

Name	Type
projectId	string
objectId	string
digest	string

Returns

ObjectRef

Defined in

src/weaveObject.ts:24

Properties

digest

• digest: string

Defined in

src/weaveObject.ts:27

---

objectId

• objectId: string

Defined in

src/weaveObject.ts:26

---

projectId

• projectId: string

Defined in

src/weaveObject.ts:25

Methods

get

▸ get(): Promise<any>

Returns

Promise<any>

Defined in

src/weaveObject.ts:64

---

ui_url

▸ ui_url(): string

Returns

string

Defined in

src/weaveObject.ts:59

---

uri

▸ uri(): string

Returns

string

Defined in

src/weaveObject.ts:55

---

fromUri

▸ fromUri(uri): ObjectRef

Creates an ObjectRef from a Weave URI string.

Parameters

Name	Type	Description
uri	string	A Weave URI in the format: weave:///entity/project/object/name:digest

Returns

ObjectRef

A new ObjectRef instance

Throws

Error if the URI format is invalid or not an object ref

Example

const ref = ObjectRef.fromUri('weave:///my-entity/my-project/object/my-dataset:abc123');

Defined in

src/weaveObject.ts:42