Skip to main content

Class: NamespaceInfo

proto.coresdk.NamespaceInfo

Info about a namespace

Properties​

limits​

• Optional limits: null | $Properties

Namespace configured limits

Methods​

toJSON​

▸ toJSON(): Object

Converts this NamespaceInfo to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): NamespaceInfo & $Properties

Creates a new NamespaceInfo instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

NamespaceInfo & $Properties

NamespaceInfo instance

▸ create(properties?): NamespaceInfo

Parameters​

NameType
properties?$Properties

Returns​

NamespaceInfo


decode​

▸ decode(reader, length?): NamespaceInfo & $Properties

Decodes a NamespaceInfo message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

NamespaceInfo & $Properties

NamespaceInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): NamespaceInfo & $Properties

Decodes a NamespaceInfo message from the specified reader or buffer, length delimited.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

NamespaceInfo & $Properties

NamespaceInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode​

▸ encode(message, writer?): Writer

Encodes the specified NamespaceInfo message. Does not implicitly coresdk.NamespaceInfo.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesNamespaceInfo message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

Encodes the specified NamespaceInfo message, length delimited. Does not implicitly coresdk.NamespaceInfo.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesNamespaceInfo message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): NamespaceInfo

Creates a NamespaceInfo message from a plain object. Also converts values to their respective internal types.

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

NamespaceInfo

NamespaceInfo


toObject​

▸ toObject(message, options?): Object

Creates a plain object from a NamespaceInfo message. Also converts values to other types if specified.

Parameters​

NameTypeDescription
messageNamespaceInfoNamespaceInfo
options?IConversionOptionsConversion options

Returns​

Object

Plain object