@payloadcms/plugin-multi-tenant
Version:
Multi Tenant plugin for Payload
36 lines • 1.14 kB
TypeScript
import type { ArrayField, RelationshipField } from 'payload';
type Args = {
/**
* Access configuration for the array field
*/
arrayFieldAccess?: ArrayField['access'];
/**
* Additional fields to include on the tenant array rows
*/
rowFields?: ArrayField['fields'];
/**
* Access configuration for the tenant field
*/
tenantFieldAccess?: RelationshipField['access'];
/**
* The name of the array field that holds the tenants
*
* @default 'tenants'
*/
tenantsArrayFieldName?: ArrayField['name'];
/**
* The name of the field that will be used to store the tenant relationship in the array
*
* @default 'tenant'
*/
tenantsArrayTenantFieldName?: RelationshipField['name'];
/**
* The slug for the tenant collection
*
* @default 'tenants'
*/
tenantsCollectionSlug?: string;
};
export declare const tenantsArrayField: ({ arrayFieldAccess, rowFields, tenantFieldAccess, tenantsArrayFieldName, tenantsArrayTenantFieldName, tenantsCollectionSlug, }: Args) => ArrayField;
export {};
//# sourceMappingURL=index.d.ts.map