Package

Defined in: js-api/src/entities/misc.ts:56

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

Extends

• Entity

Constructors

Constructor

new Package(dart?): Package

Defined in: js-api/src/entities/misc.ts:60

Parameters

Parameter	Type	Default value
dart	any	undefined

Returns

Package

Overrides

Entity.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
_version	public	string	''	-	js-api/src/entities/misc.ts:58
_webRoot	public	string | undefined	undefined	-	js-api/src/entities/misc.ts:57
dart	public	any	undefined	Entity.dart	js-api/src/entities/entity.ts:19

Accessors

author

Get Signature

get author(): any

Defined in: js-api/src/entities/entity.ts:57

Who created entity *

Returns

any

Inherited from

Entity.author

---

createdOn

Get Signature

get createdOn(): Dayjs

Defined in: js-api/src/entities/entity.ts:48

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

---

entityType

Get Signature

get entityType(): string

Defined in: js-api/src/entities/entity.ts:64

Entity type name *

Returns

string

Inherited from

Entity.entityType

---

files

Get Signature

get files(): FilesDataSource

Defined in: js-api/src/entities/misc.ts:196

Global application data

Returns

FilesDataSource

---

friendlyName

Get Signature

get friendlyName(): string

Defined in: js-api/src/entities/entity.ts:34

Entity friendly name

Returns

string

Set Signature

set friendlyName(x): void

Defined in: js-api/src/entities/entity.ts:35

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

---

id

Get Signature

get id(): string

Defined in: js-api/src/entities/entity.ts:27

Entity ID (GUID)

Returns

string

Set Signature

set id(x): void

Defined in: js-api/src/entities/entity.ts:28

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.id

---

logger

Get Signature

get logger(): PackageLogger

Defined in: js-api/src/entities/misc.ts:160

Logger whose records carry the package name.

Returns

PackageLogger

---

meta

Get Signature

get meta(): {[key: string]: any; } | null

Defined in: js-api/src/entities/misc.ts:148

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

{[key: string]: any; } | null

---

name

Get Signature

get name(): string

Defined in: js-api/src/entities/misc.ts:109

Package short name

Returns

string

Set Signature

set name(x): void

Defined in: js-api/src/entities/misc.ts:116

Entity short name

Parameters

Parameter	Type
x	string

Returns

void

Overrides

Entity.name

---

nqName

Get Signature

get nqName(): string

Defined in: js-api/src/entities/entity.ts:42

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

---

packageOwner

Get Signature

get packageOwner(): string

Defined in: js-api/src/entities/misc.ts:89

The package author.

Returns

string

---

path

Get Signature

get path(): string

Defined in: js-api/src/entities/entity.ts:45

Entity path

Returns

string

Inherited from

Entity.path

---

settings

Get Signature

get settings(): object

Defined in: js-api/src/entities/misc.ts:186

Returns settings for a package.

Returns

object

---

updatedOn

Get Signature

get updatedOn(): Dayjs | null

Defined in: js-api/src/entities/entity.ts:51

Time when entity was updated *

Returns

Dayjs | null

Inherited from

Entity.updatedOn

---

version

Get Signature

get version(): string

Defined in: js-api/src/entities/misc.ts:94

Package version.

Returns

string

Set Signature

set version(x): void

Defined in: js-api/src/entities/misc.ts:101

Parameters

Parameter	Type
x	string

Returns

void

---

webRoot

Get Signature

get webRoot(): string

Defined in: js-api/src/entities/misc.ts:77

Base URL of the package files on the server.

Returns

string

Set Signature

set webRoot(x): void

Defined in: js-api/src/entities/misc.ts:84

Parameters

Parameter	Type
x	string

Returns

void

Methods

getCredentials()

getCredentials(): Promise<Credentials>

Defined in: js-api/src/entities/misc.ts:167

Returns credentials for package.

Returns

Promise<Credentials>

---

getIconUrl()

getIconUrl(): string

Defined in: js-api/src/entities/misc.ts:132

URL of the package icon.

Returns

string

---

getModule()

getModule(file): any

Defined in: js-api/src/entities/misc.ts:137

Returns a JavaScript module for this package.

Parameters

Parameter	Type
file	string

Returns

any

---

getModuleName()

getModuleName(file): string

Defined in: js-api/src/entities/misc.ts:124

Name of the webpack module of [file] in this package.

Parameters

Parameter	Type
file	string

Returns

string

---

getProperties()

getProperties(): Promise<any>

Defined in: js-api/src/entities/misc.ts:174

Returns

Promise<any>

Deprecated

Use settings. Removed in 1.29.

Overrides

Entity.getProperties

---

getSettings()

getSettings(): Promise<Map<string, any>>

Defined in: js-api/src/entities/misc.ts:181

Returns

Promise<Map<string, any>>

Deprecated

Use settings. Removed in 1.29.

---

getTests()

getTests(core?): Promise<any>

Defined in: js-api/src/entities/misc.ts:201

Loads the package test module and returns its registered tests; undefined when the package has none.

Parameters

Parameter	Type	Default value
core	boolean	false

Returns

Promise<any>

---

hasTag()

hasTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:79

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

---

init()

init(): Promise<null>

Defined in: js-api/src/entities/misc.ts:72

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>

---

load()

load(options?): Promise<Package>

Defined in: js-api/src/entities/misc.ts:153

Loads package.

Parameters

Parameter	Type
options?	{ file: string; }
options.file?	string

Returns

Promise<Package>

---

newId()

newId(): void

Defined in: js-api/src/entities/entity.ts:31

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

---

setProperties()

setProperties(props): Promise<any>

Defined in: js-api/src/entities/entity.ts:72

Sets entity properties

Parameters

Parameter	Type
props	{[index: string]: any; }

Returns

Promise<any>

Inherited from

Entity.setProperties

---

setSettings()

setSettings(props, group): Promise<void>

Defined in: js-api/src/entities/misc.ts:191

Updates settings for a package.

Parameters

Parameter	Type
props	Map<string, any>
group	Group

Returns

Promise<void>

---

tag()

tag(tag): boolean

Defined in: js-api/src/entities/entity.ts:82

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

---

toString()

toString(): string

Defined in: js-api/src/entities/entity.ts:77

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

---

unTag()

unTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:85

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag