Skip to content
API reference

tenancy/registry

Import
import * as api from "@fungi.computer/oyster/tenancy/registry";
Kind Export Description
type alias MemoryMembership Initial live membership records for a disposable in-memory registry.
type alias MemoryRegistryOptions Provisioned records and canonical member mappings owned by the host.
type alias MemoryRegistry The memory adapter always supplies the optional custom-domain index.
function memoryRegistry() In-memory tenant and member owner; create updates both atomically.

MemoryMembershiptype alias

Section titled “MemoryMembership”
Signature
type MemoryMembership = Readonly<{
tenantId: TenantId;
identity: Identity;
memberId: string;
role: Membership["role"];
}>;

Initial live membership records for a disposable in-memory registry.


MemoryRegistryOptionstype alias

Section titled “MemoryRegistryOptions”
Signature
type MemoryRegistryOptions = Readonly<{
tenants?: readonly Tenant[];
memberships?: readonly MemoryMembership[];
}>;

Provisioned records and canonical member mappings owned by the host.


MemoryRegistrytype alias

Section titled “MemoryRegistry”
Signature
type MemoryRegistry = ManagedTenantRegistry &
Readonly<{
byDomain: Promise<Readonly<{
id: TenantId;
handle: string;
origin: string;
status: "active" | "suspended" | "deleting";
owners: readonly string[];
domains: readonly string[];
}> | null>;
}>;

The memory adapter always supplies the optional custom-domain index.

memoryRegistry()function

Section titled “memoryRegistry()”
Signature
function memoryRegistry(options?): MemoryRegistry;

In-memory tenant and member owner; create updates both atomically.

Parameter Type
options MemoryRegistryOptions

MemoryRegistry