role.md

title	isDefaultIndex	generated
Role	false	true

import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';

Role

A Role represents a collection of permissions which determine the authorization level of a User on a given set of Channels.

class Role extends VendureEntity implements ChannelAware {
    constructor(input?: DeepPartial<Role>)
    @Column() code: string;
    @Column() description: string;
    @Column('simple-array') permissions: Permission[];
    @ManyToMany(type => Channel, channel => channel.roles)
    @JoinTable()
    channels: Channel[];
}

• Extends: VendureEntity

• Implements: ChannelAware

constructor

<MemberInfo kind="method" type={(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/role#role'>Role</a>&#62;) => Role} />

code

<MemberInfo kind="property" type={string} />

description

<MemberInfo kind="property" type={string} />

permissions

<MemberInfo kind="property" type={<a href='/reference/typescript-api/common/permission#permission'>Permission</a>[]} />

channels

<MemberInfo kind="property" type={<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>[]} />