Skip to main content

Session

Session​

@vendure/coresession.entity.ts

A Session is created when a user makes a request to restricted API operations. A Session can be an AnonymousSession in the case of un-authenticated users, otherwise it is an AuthenticatedSession.

Signature
class Session extends VendureEntity implements HasCustomFields {
    @Index({ unique: true })
    @Column()
    token: string;
    @Column() expires: Date;
    @Column() invalidated: boolean;
    @EntityId({ nullable: true })
    activeOrderId?: ID;
    @Index()
    @ManyToOne(type => Order)
    activeOrder: Order | null;
    @EntityId({ nullable: true })
    activeChannelId?: ID;
    @Index()
    @ManyToOne(type => Channel)
    activeChannel: Channel | null;
    @Column(type => CustomSessionFields)
    customFields: CustomSessionFields;
}

token​

property
string

expires​

property
Date

invalidated​

property
boolean

activeOrderId​

property
ID

activeOrder​

property
Order | null

activeChannelId​

property
ID

activeChannel​

property
Channel | null

customFields​

property
CustomSessionFields