Skip to content
VentureKit

@venturekit-pro/tenancy

Installation

Section titled “Installation”
Terminal window
npm install @venturekit-pro/tenancy@dev

What It Provides

Section titled “What It Provides”

Tenant Context

Section titled “Tenant Context”
import { TenantContext, createTenantContext, getCurrentTenant, resolveTenant } from '@venturekit-pro/tenancy';


const tenant = getCurrentTenant(ctx);
// { id: 'acme', slug: 'acme', metadata: { ... } }

Middleware

Section titled “Middleware”
import { createTenantMiddleware, createQuotaMiddleware } from '@venturekit-pro/tenancy';


// Add to handler middleware
middleware: [
  createTenantMiddleware({ strategy: 'subdomain' }),
  createQuotaMiddleware(),
]

Error Types

Section titled “Error Types”
import { TenantNotFoundError, TenantSuspendedError, TenantInactiveError, QuotaExceededError } from '@venturekit-pro/tenancy';

Quota Checking

Section titled “Quota Checking”
import { checkQuotas } from '@venturekit-pro/tenancy';


await checkQuotas(tenantId, {
  apiRequests: { limit: 10000, period: 'month' },
});

Resolution Strategies

Section titled “Resolution Strategies”
StrategySource
subdomainacme.app.example.com
custom-domainapp.acme.com (domain lookup)
path/t/acme/api/tasks
headerX-Tenant-ID: acme
jwttenant_id claim

Dependencies

Section titled “Dependencies”
  • @venturekit/core — required
Section titled “Related”