Class: Package

dg.Package

Represents a package, which is a unit of distribution of content in the Datagrok platform.

Hierarchy

• Entity

  ↳ Package

Constructors

constructor

• new Package(dart?)

Parameters

Name	Type	Default value
dart	any	undefined

Overrides

Entity.constructor

Defined in

src/entities.ts:977

Properties

_files

• Private _files: null | FileSource = null

Defined in

src/entities.ts:1096

---

_logger

• Private Optional _logger: PackageLogger

Defined in

src/entities.ts:1065

---

_name

• Private _name: string = ''

Defined in

src/entities.ts:991

---

_version

• _version: string = ''

Defined in

src/entities.ts:975

---

_webRoot

• _webRoot: undefined | string

Defined in

src/entities.ts:974

---

dart

• dart: any

Inherited from

Entity.dart

Defined in

src/entities.ts:67

Accessors

author

• get author(): User

Who created entity *

Returns

User

Inherited from

Entity.author

Defined in

src/entities.ts:104

---

createdOn

• get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

Defined in

src/entities.ts:98

---

files

• get files(): FileSource

Global application data

Returns

FileSource

Defined in

src/entities.ts:1099

---

friendlyName

• get friendlyName(): string

Entity friendly name

Returns

string

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:84

• set friendlyName(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:85

---

id

• get id(): string

Entity ID (GUID)

Returns

string

Inherited from

Entity.id

Defined in

src/entities.ts:76

• set id(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.id

Defined in

src/entities.ts:77

---

logger

• get logger(): PackageLogger

Returns

PackageLogger

Defined in

src/entities.ts:1067

---

meta

• get meta(): Object

Returns metadata associated with the package. The metadata gets generated when the package is built. It is a concatenation of JSON files located under the /meta folder. See example: /packages/PowerPack.

Returns

Object

Defined in

src/entities.ts:1056

---

name

• get name(): string

Package short name

Returns

string

Overrides

Entity.name

Defined in

src/entities.ts:1019

• set name(x): void

Parameters

Name	Type
x	string

Returns

void

Overrides

Entity.name

Defined in

src/entities.ts:1026

---

nqName

• get nqName(): string

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

Defined in

src/entities.ts:92

---

path

• get path(): string

Entity path

Returns

string

Inherited from

Entity.path

Defined in

src/entities.ts:95

---

updatedOn

• get updatedOn(): Dayjs

Time when entity was updated *

Returns

Dayjs

Inherited from

Entity.updatedOn

Defined in

src/entities.ts:101

---

version

• get version(): string

Returns

string

Defined in

src/entities.ts:1004

• set version(x): void

Parameters

Name	Type
x	string

Returns

void

Defined in

src/entities.ts:1011

---

webRoot

• get webRoot(): string

Returns

string

Defined in

src/entities.ts:993

• set webRoot(x): void

Parameters

Name	Type
x	string

Returns

void

Defined in

src/entities.ts:1000

Methods

getCredentials

▸ getCredentials(): Promise<Credentials>

Returns credentials for package.

Returns

Promise<Credentials>

Defined in

src/entities.ts:1074

---

getIconUrl

▸ getIconUrl(): string

Returns

string

Defined in

src/entities.ts:1040

---

getModule

▸ getModule(file): any

Returns a JavaScript module for this package.

Parameters

Name	Type
file	string

Returns

any

Defined in

src/entities.ts:1045

---

getModuleName

▸ getModuleName(file): string

Parameters

Name	Type
file	string

Returns

string

Defined in

src/entities.ts:1033

---

getProperties

▸ getProperties(): Promise<any>

Deprecated. Use getSettings instead. Returns properties for a package.

Returns

Promise<any>

Overrides

Entity.getProperties

Defined in

src/entities.ts:1082

---

getSettings

▸ getSettings(): Promise<any>

Returns settings for a package.

Returns

Promise<any>

Defined in

src/entities.ts:1087

---

hasTag

▸ hasTag(tag): boolean

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

Defined in

src/entities.ts:119

---

init

▸ init(): Promise<null>

Override init() method to provide package-specific initialization. It is guaranteed to get called exactly once before the execution of any function below.

Returns

Promise<null>

Defined in

src/entities.ts:989

---

load

▸ load(options?): Promise<Package>

Loads package.

Parameters

Name	Type
options?	Object
options.file	string

Returns

Promise<Package>

Defined in

src/entities.ts:1061

---

newId

▸ newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

Defined in

src/entities.ts:80

---

setProperties

▸ setProperties(props): Promise<any>

Sets entity properties

Parameters

Name	Type
props	Object

Returns

Promise<any>

Inherited from

Entity.setProperties

Defined in

src/entities.ts:112

---

setSettings

▸ setSettings(props, group): Promise<void>

Updates settings for a package.

Parameters

Name	Type
props	Map<string, any>
group	Group

Returns

Promise<void>

Defined in

src/entities.ts:1092

---

tag

▸ tag(tag): boolean

Adds a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

Defined in

src/entities.ts:122

---

toString

▸ toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

Defined in

src/entities.ts:117

---

unTag

▸ unTag(tag): boolean

Removes a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag

Defined in

src/entities.ts:125