Skip to main content

Role

Role​

@vendure/corerole.entity.ts

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

Signature
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[];
}

constructor​

method
(input?: DeepPartial<Role>) => Role

code​

property
string

description​

property
string

permissions​

property
Permission[]

channels​

property
Channel[]