API reference
tenancy/resolve
Import
Section titled “Import”import * as api from "@fungi.computer/oyster/tenancy/resolve";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| function | subdomain() | Resolve a provisioned label immediately below a configured base hostname. |
| function | hosts() | Resolve a provisioned custom domain through the registry’s domain index. |
| function | path() | Resolve provisioned path tenants for APIs; this resolver cannot host Oyster. |
subdomain()function
Section titled “subdomain()”function subdomain(baseDomain): TenantResolverAdapter<"origin">;Resolve a provisioned label immediately below a configured base hostname.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
baseDomain |
string |
Returns
Section titled “Returns”TenantResolverAdapter<"origin">
hosts()function
Section titled “hosts()”function hosts(registry): TenantResolverAdapter<"origin">;Resolve a provisioned custom domain through the registry’s domain index.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
registry |
ReadonlyTenantRegistry |
Returns
Section titled “Returns”TenantResolverAdapter<"origin">
path()function
Section titled “path()”function path(pattern): TenantResolverAdapter<"path">;Resolve provisioned path tenants for APIs; this resolver cannot host Oyster.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
pattern |
string |
Returns
Section titled “Returns”TenantResolverAdapter<"path">