Skip to main content
Module

x/steam_trader/types/protobuf.d.ts>Enum

https://deno.land/x/steam_trader
Latest
class Enum
import { Enum } from "https://deno.land/x/steam_trader@v0.4.0/types/protobuf.d.ts";

Reflected enum.

Constructors

new
Enum(
name: string,
values?: { [k: string]: number; },
options?: { [k: string]: any; },
comment?: string,
comments?: { [k: string]: string; },
)

Constructs a new enum instance.

Properties

comment: (string | null)

Enum comment text.

comments: { [k: string]: string; }

Value comment texts, if any.

reserved: (number[] | string)[]

Reserved ranges, if any.

values: { [k: string]: number; }

Enum values by name.

valuesById: { [k: number]: string; }

Enum values by id.

Methods

add(
name: string,
id: number,
comment?: string,
): Enum

Adds a value to this enum.

isReservedId(id: number): boolean

Tests if the specified id is reserved.

isReservedName(name: string): boolean

Tests if the specified name is reserved.

remove(name: string): Enum

Removes a value from this enum

toJSON(toJSONOptions?: IToJSONOptions): IEnum

Converts this enum to an enum descriptor.

Static Methods

fromJSON(name: string, json: IEnum): Enum

Constructs an enum from an enum descriptor.