@codesoul-co/hypha-core / modules/runtime/runtime-capacity-semaphore

• Package index: @codesoul-co/hypha-core
• Source: packages/core/src/modules/runtime/runtime-capacity-semaphore.ts
• Exports: 2

Using this module

Use the Runtime capacity semaphore module for executing runtime behavior at this boundary. It exports 1 class, 1 interface.

Import from the package entrypoint

import {
  InMemoryRuntimeCapacitySemaphore,
} from '@codesoul-co/hypha-core';

import type {
  InMemoryRuntimeCapacitySemaphoreOptions,
} from '@codesoul-co/hypha-core';

Usage patterns

• Use the 1 type/interface export as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
InMemoryRuntimeCapacitySemaphore	class	new InMemoryRuntimeCapacitySemaphore(options: InMemoryRuntimeCapacitySemaphoreOptions): InMemoryRuntimeCapacitySemaphore	In Memory Runtime Capacity Semaphore class with 6 public constructor or member entries; its exact declarations are listed below.
InMemoryRuntimeCapacitySemaphoreOptions	interface	interface InMemoryRuntimeCapacitySemaphoreOptions	In Memory Runtime Capacity Semaphore Options interface with 1 public fields or methods.

InMemoryRuntimeCapacitySemaphore

In Memory Runtime Capacity Semaphore class with 6 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { InMemoryRuntimeCapacitySemaphore } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-capacity-semaphore

Declaration

export declare class InMemoryRuntimeCapacitySemaphore implements RuntimeCapacitySemaphore {
    constructor(options: InMemoryRuntimeCapacitySemaphoreOptions);
    acquire(request: RuntimeCapacityAcquireRequest): Promise<RuntimeCapacityLease | null>;
    renew(request: RuntimeCapacityRenewRequest): Promise<RuntimeCapacityLease>;
    release(request: RuntimeCapacityReleaseRequest): Promise<void>;
    assertCurrent(request: RuntimeCapacityAssertionRequest): Promise<RuntimeCapacityLease>;
    usage(request: RuntimeCapacityUsageRequest): Promise<RuntimeCapacityUsage>;
}

Public members

Member	Kind	Signature	Description
acquire	method	acquire(request: RuntimeCapacityAcquireRequest): Promise<RuntimeCapacityLease | null>	Public method; parameters and return type are shown in the signature.
assertCurrent	method	assertCurrent(request: RuntimeCapacityAssertionRequest): Promise<RuntimeCapacityLease>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: InMemoryRuntimeCapacitySemaphoreOptions): InMemoryRuntimeCapacitySemaphore	Creates an instance of this class.
release	method	release(request: RuntimeCapacityReleaseRequest): Promise<void>	Public method; parameters and return type are shown in the signature.
renew	method	renew(request: RuntimeCapacityRenewRequest): Promise<RuntimeCapacityLease>	Public method; parameters and return type are shown in the signature.
usage	method	usage(request: RuntimeCapacityUsageRequest): Promise<RuntimeCapacityUsage>	Public method; parameters and return type are shown in the signature.

InMemoryRuntimeCapacitySemaphoreOptions

In Memory Runtime Capacity Semaphore Options interface with 1 public fields or methods.

• Kind: interface
• Import: import type { InMemoryRuntimeCapacitySemaphoreOptions } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-capacity-semaphore

Declaration

export interface InMemoryRuntimeCapacitySemaphoreOptions {
    policy: RuntimeCapacityPolicy;
}

Contract members

Member	Kind	Signature	Description
policy	property	policy: RuntimeCapacityPolicy	Public property; its type, readonly modifier and optionality are shown in the signature.