Credits

Datalayer Core

---

Datalayer Core / Credits

Class: Credits

Defined in: src/models/CreditsDTO.ts:69

Credits model representing user's available credits and usage.

Example

const credits = await sdk.getCredits();
console.log(`Available: ${credits.available}`);
console.log(`Quota: ${credits.quota || 'unlimited'}`);

// Calculate maximum runtime for an environment
const maxMinutes = credits.calculateMaxRuntimeMinutes(environment.burningRate);

Constructors

Constructor

new Credits(data, reservations): CreditsDTO

Defined in: src/models/CreditsDTO.ts:75

Parameters

data

CreditsInfo

reservations

CreditReservation[] = []

Returns

CreditsDTO

Properties

_data

_data: CreditsInfo

Defined in: src/models/CreditsDTO.ts:71

Internal

Accessors

available

Get Signature

get available(): number

Defined in: src/models/CreditsDTO.ts:83

Available credits for the user.

Returns

number

---

hasActiveRuntimes

Get Signature

get hasActiveRuntimes(): boolean

Defined in: src/models/CreditsDTO.ts:133

Check if there are any active runtime reservations.

Returns

boolean

---

lastUpdate

Get Signature

get lastUpdate(): string

Defined in: src/models/CreditsDTO.ts:98

Last update timestamp.

Returns

string

---

netAvailable

Get Signature

get netAvailable(): number

Defined in: src/models/CreditsDTO.ts:119

Net available credits (available minus reserved).

Returns

number

---

quota

Get Signature

get quota(): number | null

Defined in: src/models/CreditsDTO.ts:91

Credit quota for the user. Returns null if unlimited.

Returns

number | null

---

reservations

Get Signature

get reservations(): CreditReservation[]

Defined in: src/models/CreditsDTO.ts:105

Active credit reservations.

Returns

CreditReservation[]

---

runtimeReservations

Get Signature

get runtimeReservations(): CreditReservation[]

Defined in: src/models/CreditsDTO.ts:126

Get runtime reservations (reservations that start with 'runtime-').

Returns

CreditReservation[]

---

totalReserved

Get Signature

get totalReserved(): number

Defined in: src/models/CreditsDTO.ts:112

Total reserved credits across all reservations.

Returns

number

Methods

calculateCreditsFromMinutes()

calculateCreditsFromMinutes(minutes, burningRate): number

Defined in: src/models/CreditsDTO.ts:156

Calculate credits needed for runtime duration.

Parameters

minutes

number

Runtime duration in minutes

burningRate

number

Credits consumed per hour

Returns

number

Credits needed

---

calculateMaxRuntimeMinutes()

calculateMaxRuntimeMinutes(burningRate): number

Defined in: src/models/CreditsDTO.ts:143

Calculate maximum runtime in minutes based on environment burning rate.

Parameters

burningRate

number

Credits consumed per hour

Returns

number

Maximum runtime in minutes

---

hasEnoughCreditsForRuntime()

hasEnoughCreditsForRuntime(minutes, burningRate): boolean

Defined in: src/models/CreditsDTO.ts:168

Check if user has enough credits for runtime.

Parameters

minutes

number

Runtime duration in minutes

burningRate

number

Credits consumed per hour

Returns

boolean

True if user has enough credits

---

toJSON()

toJSON(): CreditsInfo & object

Defined in: src/models/CreditsDTO.ts:179

Convert to JSON representation.

Returns

CreditsInfo & object

---

toString()

toString(): string

Defined in: src/models/CreditsDTO.ts:192

String representation of credits.

Returns

string