Class: Dataset<R>

TypeScript SDK reference

weave / Dataset

Dataset object with easy saving and automatic versioning

Example

// Create a dataset
const dataset = new Dataset({
  id: 'grammar-dataset',
  rows: [
    { id: '0', sentence: "He no likes ice cream.", correction: "He doesn't like ice cream." },
    { id: '1', sentence: "She goed to the store.", correction: "She went to the store." },
    { id: '2', sentence: "They plays video games all day.", correction: "They play video games all day." }
  ]
})

// Access a specific example
const exampleLabel = dataset.getRow(2).sentence;

// Save the dataset
const ref = await dataset.save()

Type parameters

Name	Type
R	extends DatasetRow

Hierarchy

• WeaveObject

  ↳ Dataset

Table of contents

Constructors

• constructor

Properties

• __savedRef
• rows

Accessors

• description
• length
• name

Methods

• [asyncIterator]
• getRow
• save
• saveAttrs

Constructors

constructor

• new Dataset<R>(parameters): Dataset<R>

Type parameters

Name	Type
R	extends DatasetRow

Parameters

Name	Type
parameters	DatasetParameters<R>

Returns

Dataset<R>

Overrides

WeaveObject.constructor

Defined in

src/dataset.ts:55

Properties

__savedRef

• Optional __savedRef: ObjectRef | Promise<ObjectRef>

Inherited from

WeaveObject.__savedRef

Defined in

src/weaveObject.ts:71

---

rows

• rows: Table<R>

Defined in

src/dataset.ts:53

Accessors

description

• get description(): undefined | string

Returns

undefined | string

Inherited from

WeaveObject.description

Defined in

src/weaveObject.ts:98

---

length

• get length(): number

Returns

number

Defined in

src/dataset.ts:68

---

name

• get name(): string

Returns

string

Inherited from

WeaveObject.name

Defined in

src/weaveObject.ts:94

Methods

[asyncIterator]

▸ [asyncIterator](): AsyncIterator<any, any, any>

Returns

AsyncIterator<any, any, any>

Defined in

src/dataset.ts:72

---

getRow

▸ getRow(index): R

Parameters

Name	Type
index	number

Returns

R

Defined in

src/dataset.ts:78

---

save

▸ save(): Promise<ObjectRef>

Returns

Promise<ObjectRef>

Defined in

src/dataset.ts:64

---

saveAttrs

▸ saveAttrs(): Object

Returns

Object

Inherited from

WeaveObject.saveAttrs

Defined in

src/weaveObject.ts:75