Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a User.

Hierarchy

  • User

Implements

Index

Constructors

constructor

  • Constructs a new User.

    Parameters

    • Optional properties: IUser

    Returns User

Properties

id

id: number

User id.

name

name: string

User name.

roles

roles: string[]

User roles.

session

session: number

User session.

Methods

toJSON

  • toJSON(): object
  • Converts this User to JSON.

    Returns object

    JSON object

    • [k: string]: any

Static create

  • Creates a new User instance using the specified properties.

    Parameters

    • Optional properties: IUser

    Returns User

    User instance

Static decode

  • decode(reader: Reader | Uint8Array, length?: undefined | number): User
  • Decodes a User message from the specified reader or buffer.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Reader | Uint8Array

      Reader or buffer to decode from

    • Optional length: undefined | number

    Returns User

    User

Static decodeDelimited

  • decodeDelimited(reader: Reader | Uint8Array): User
  • Decodes a User message from the specified reader or buffer, length delimited.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Reader | Uint8Array

      Reader or buffer to decode from

    Returns User

    User

Static encode

  • encode(message: IUser, writer?: $protobuf.Writer): Writer
  • Encodes the specified User message. Does not implicitly verify messages.

    Parameters

    • message: IUser

      User message or plain object to encode

    • Optional writer: $protobuf.Writer

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message: IUser, writer?: $protobuf.Writer): Writer
  • Encodes the specified User message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IUser

      User message or plain object to encode

    • Optional writer: $protobuf.Writer

    Returns Writer

    Writer

Static fromObject

  • fromObject(object: object): User
  • Creates a User message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: object

      Plain object

      • [k: string]: any

    Returns User

    User

Static toObject

  • toObject(message: User, options?: $protobuf.IConversionOptions): object
  • Creates a plain object from a User message. Also converts values to other types if specified.

    Parameters

    • message: User

      User

    • Optional options: $protobuf.IConversionOptions

    Returns object

    Plain object

    • [k: string]: any

Static verify

  • verify(message: object): null | string
  • Verifies a User message.

    Parameters

    • message: object

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc