Function createPermissionRule

createPermissionRule<
    TRef extends PermissionResourceRef,
    TParams extends PermissionRuleParams = undefined,
>(
    rule: CreatePermissionRuleOptions<TRef, TParams>,
): PermissionRule<
    TRef["TResource"],
    TRef["TQuery"],
    TRef["resourceType"],
    TParams,
>
Helper function to create a PermissionRule for a specific resource type using a PermissionResourceRef.
Type Parameters
- TRef extends PermissionResourceRef
- TParams extends PermissionRuleParams = undefined
Parameters
- rule: CreatePermissionRuleOptions<TRef, TParams>
Returns PermissionRule<TRef["TResource"], TRef["TQuery"], TRef["resourceType"], TParams>
- Defined in plugins/permission-node/src/integration/createPermissionRule.ts:70
createPermissionRule<
    TRef extends PermissionResourceRef,
    TParams extends PermissionRuleParams = undefined,
>(
    rule: {
        description: string;
        name: string;
        paramsSchema: ZodType<TParams>;
        resourceRef: TRef;
        apply(resource: TRef["TResource"], params: NoInfer<TParams>): boolean;
        toQuery(params: NoInfer<TParams>): PermissionCriteria<TRef["TQuery"]>;
    },
): PermissionRule<
    TRef["TResource"],
    TRef["TQuery"],
    TRef["resourceType"],
    TParams,
>
Type Parameters
- TRef extends PermissionResourceRef
- TParams extends PermissionRuleParams = undefined
Parameters
- rule: {
      description: string;
      name: string;
      paramsSchema: ZodType<TParams>;
      resourceRef: TRef;
      apply(resource: TRef["TResource"], params: NoInfer<TParams>): boolean;
      toQuery(params: NoInfer<TParams>): PermissionCriteria<TRef["TQuery"]>;
  }
Returns PermissionRule<TRef["TResource"], TRef["TQuery"], TRef["resourceType"], TParams>

Deprecated
Zod v3 parameter schemas are deprecated, switch to a JSON Schema-compatible Standard Schema instead, such as Zod v4.
- Defined in plugins/permission-node/src/integration/createPermissionRule.ts:85
createPermissionRule<
    TResource,
    TQuery,
    TResourceType extends string,
    TParams extends PermissionRuleParams = undefined,
>(
    rule: PermissionRule<TResource, TQuery, TResourceType, TParams>,
): PermissionRule<TResource, TQuery, TResourceType, TParams>
Helper function to ensure that PermissionRule definitions are typed correctly.
Type Parameters
- TResource
- TQuery
- TResourceType extends string
- TParams extends PermissionRuleParams = undefined
Parameters
- rule: PermissionRule<TResource, TQuery, TResourceType, TParams>
Returns PermissionRule<TResource, TQuery, TResourceType, TParams>

Deprecated
Use the version of createPermissionRule that accepts a resourceRef option instead.
- Defined in plugins/permission-node/src/integration/createPermissionRule.ts:107

Function createPermissionRule

Type Parameters

Parameters

Returns PermissionRule<TRef["TResource"], TRef["TQuery"], TRef["resourceType"], TParams>

Type Parameters

Parameters

Returns PermissionRule<TRef["TResource"], TRef["TQuery"], TRef["resourceType"], TParams>

Deprecated

Type Parameters

Parameters

Returns PermissionRule<TResource, TQuery, TResourceType, TParams>

Deprecated

Settings