Platform modulesModule reference4 values4 types

Governance Quotas

Usage metering and quota utilities used by the API service layer to enforce billable operation policies.

Initialize the Prisma bridge via `setPrismaClient()` before calling quota/metering utilities.

trackUsage

functiontrackUsage

trackUsage(event: MeteringEvent): Promise<void>

Parameters

Name	Type	Flags
event	MeteringEvent	required

TypeScript SDKTypeScript

import { trackUsage } from "@arelis-ai/arelis-governance-sdk";

// @arelis-ai/governance-quotas
// Signature: trackUsage(event: MeteringEvent): Promise<void>

const result = await trackUsage(...[] as unknown[]);
console.log(result);

Return

// Return type
Promise<void>

getUsage

functiongetUsage

getUsage(projectId: string, environmentId: string, operationType?: OperationType): Promise<UsageSummary[]>

Parameters

Name	Type	Flags
projectId	string	required
environmentId	string	required
operationType	OperationType	optional

TypeScript SDKTypeScript

import { getUsage } from "@arelis-ai/arelis-governance-sdk";

// @arelis-ai/governance-quotas
// Signature: getUsage(projectId: string, environmentId: string, operationType?: OperationType): Promise<UsageSummary[]>

const result = await getUsage(...[] as unknown[]);
console.log(result);

Return

// Return type
Promise<UsageSummary[]>

checkQuota

functioncheckQuota

checkQuota(projectId: string, environmentId: string, operationType: OperationType): Promise<QuotaCheckResult>

Parameters

Name	Type	Flags
projectId	string	required
environmentId	string	required
operationType	OperationType	required

TypeScript SDKTypeScript

import { checkQuota } from "@arelis-ai/arelis-governance-sdk";

// @arelis-ai/governance-quotas
// Signature: checkQuota(projectId: string, environmentId: string, operationType: OperationType): Promise<QuotaCheckResult>

const result = await checkQuota(...[] as unknown[]);
console.log(result);

Return

// Return type
Promise<QuotaCheckResult>

setPrismaClient

functionsetPrismaClient

setPrismaClient(prisma: PrismaLike): void

Parameters

Name	Type	Flags
prisma	PrismaLike	required

TypeScript SDKTypeScript

import { setPrismaClient } from "@arelis-ai/arelis-governance-sdk";

// @arelis-ai/governance-quotas
// Signature: setPrismaClient(prisma: PrismaLike): void

const result = await setPrismaClient(...[] as unknown[]);
console.log(result);

Return

// Return type
void