API reference
tenancy/registry
Import
Section titled “Import”import * as api from "@fungi.computer/oyster/tenancy/registry";Exports
Section titled “Exports”| 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”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”type MemoryRegistryOptions = Readonly<{ tenants?: readonly Tenant[]; memberships?: readonly MemoryMembership[];}>;Provisioned records and canonical member mappings owned by the host.
MemoryRegistrytype alias
Section titled “MemoryRegistry”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()”function memoryRegistry(options?): MemoryRegistry;In-memory tenant and member owner; create updates both atomically.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options |
MemoryRegistryOptions |