Workspaces.md

@neuralinnovations/dataisland-sdk - v0.0.1-dev54 / Exports / Workspaces

Class: Workspaces

Organization's workspaces.

Hierarchy

• EventDispatcher<WorkspacesEvent, Workspace>

  ↳ Workspaces

Table of contents

Constructors

• constructor

Accessors

• collection

Methods

• contains
• create
• delete
• dispatch
• get
• subscribe
• tryGet

Constructors

constructor

• new Workspaces(): Workspaces

Returns

Workspaces

Inherited from

EventDispatcher.constructor

Accessors

collection

• get collection(): readonly Workspace[]

Workspaces.

Returns

readonly Workspace[]

Methods

contains

▸ contains(id): boolean

Check if workspace exists.

Parameters

Name	Type
id	string

Returns

boolean

---

create

▸ create(name, description, regulation?): Promise<undefined | Workspace>

Create workspace.

Parameters

Name	Type
name	string
description	string
regulation?	Object
regulation.groupIds?	string[]
regulation.isCreateNewGroup	boolean
regulation.newGroupName?	string

Returns

Promise<undefined | Workspace>

---

delete

▸ delete(id): Promise<void>

Delete workspace.

Parameters

Name	Type
id	string

Returns

Promise<void>

---

dispatch

▸ dispatch(input): void

Parameters

Name	Type
input	Input<WorkspacesEvent, Workspace>

Returns

void

Inherited from

EventDispatcher.dispatch

---

get

▸ get(id): Workspace

Get workspace by id.

Parameters

Name	Type
id	string

Returns

Workspace

---

subscribe

▸ subscribe(callback, type?): Disposable

Parameters

Name	Type
callback	(event: Event<WorkspacesEvent, Workspace>) => void
type?	WorkspacesEvent

Returns

Disposable

Inherited from

EventDispatcher.subscribe

---

tryGet

▸ tryGet(id): undefined | Workspace

Try to get workspace by id.

Parameters

Name	Type
id	string

Returns

undefined | Workspace