Skip to content

[V] $lib

const $lib: TypeSpecLibrary<object, ProtobufEmitterOptions, never> = TypeSpecProtobufLibrary;

Type declaration

NameTypeDefault value
anonymous-modelobject-
anonymous-model.default"anonymous models cannot be used in Protobuf messages"ā€anonymous models cannot be used in Protobuf messagesā€
field-indexobject-
field-index.invalidCallableMessage<["index"]>-
field-index.missingCallableMessage<["name"]>-
field-index.out-of-boundsCallableMessage<["index", "max"]>-
field-index.reservedCallableMessage<["index"]>-
field-index.user-reservedCallableMessage<["index"]>-
field-index.user-reserved-rangeCallableMessage<["index"]>-
field-nameobject-
field-name.user-reservedCallableMessage<["name"]>-
illegal-reservationobject-
illegal-reservation.default"reservation value must be a string literal, uint32 literal, or a tuple of two uint32 literals denoting a range"ā€reservation value must be a string literal, uint32 literal, or a tuple of two uint32 literals denoting a rangeā€
invalid-package-nameobject-
invalid-package-name.defaultCallableMessage<["name"]>-
model-not-in-packageobject-
model-not-in-package.defaultCallableMessage<["name"]>-
namespace-collisionobject-
namespace-collision.defaultCallableMessage<["name"]>-
nested-arrayobject-
nested-array.default"nested arrays are not supported by the Protobuf emitter"ā€nested arrays are not supported by the Protobuf emitterā€
packageobject-
package.disallowed-option-typeCallableMessage<["name", "type"]>-
root-operationobject-
root-operation.default"operations in the root namespace are not supported (no associated Protobuf service)"ā€operations in the root namespace are not supported (no associated Protobuf service)ā€œ
unconvertible-enumobject-
unconvertible-enum.default"enums must explicitly assign exactly one integer to each member to be used in a Protobuf message"ā€enums must explicitly assign exactly one integer to each member to be used in a Protobuf messageā€
unconvertible-enum.no-zero-first"the first variant of an enum must be set to zero to be used in a Protobuf message"ā€the first variant of an enum must be set to zero to be used in a Protobuf messageā€
unspeakable-template-argumentobject-
unspeakable-template-argument.defaultCallableMessage<["name"]>-
unsupported-field-typeobject-
unsupported-field-type.recursive-map"a protobuf map's 'value' type may not refer to another map"ā€a protobuf mapā€™s ā€˜valueā€™ type may not refer to another mapā€
unsupported-field-type.unconvertibleCallableMessage<["type"]>-
unsupported-field-type.union"a message field's type may not be a union"ā€a message fieldā€™s type may not be a unionā€
unsupported-field-type.unknown-intrinsicCallableMessage<["name"]>-
unsupported-field-type.unknown-scalarCallableMessage<["name"]>-
unsupported-input-typeobject-
unsupported-input-type.unconvertible"input parameters cannot be converted to a Protobuf message"ā€input parameters cannot be converted to a Protobuf messageā€
unsupported-input-type.wrong-number"Protobuf methods must accept exactly one Model input (an empty model will do)"ā€Protobuf methods must accept exactly one Model input (an empty model will do)ā€œ
unsupported-input-type.wrong-type"Protobuf methods may only accept a named Model as an input"ā€Protobuf methods may only accept a named Model as an inputā€
unsupported-intrinsicobject-
unsupported-intrinsic.defaultCallableMessage<["name"]>-
unsupported-return-typeobject-
unsupported-return-type.default"Protobuf methods must return a named Model"ā€Protobuf methods must return a named Modelā€