@grpc/proto-loader

Functions

• fromJSON()
• isAnyExtension()
• load()
• loadFileDescriptorSetFromBuffer()
• loadFileDescriptorSetFromObject()
• loadSync()

Interfaces

• AnyExtension

  • '@type'
• Deserialize
• EnumTypeDefinition

  • format
• MessageTypeDefinition

  • deserialize
  • format
  • serialize
• MethodDefinition

  • options
  • originalName
  • path
  • requestDeserialize
  • requestSerialize
  • requestStream
  • requestType
  • responseDeserialize
  • responseSerialize
  • responseStream
  • responseType
• MethodOptions

  • deprecated
  • idempotency_level
  • uninterpreted_option
• NamePart

  • is_extension
  • name_part
• PackageDefinition
• ProtobufTypeDefinition

  • fileDescriptorProtos
  • format
  • type
• Serialize
• ServiceDefinition
• UninterpretedOption

  • aggregate_value
  • double_value
  • identifier_value
  • name
  • negative_int_value
  • positive_int_value
  • string_value

Enums

• IdempotencyLevel

  • IDEMPOTENCY_UNKNOWN
  • IDEMPOTENT
  • NO_SIDE_EFFECTS

Type Aliases

• AnyDefinition
• Options

function fromJSON

fromJSON: (json: Protobuf.INamespace, options?: Options) => PackageDefinition;

function isAnyExtension

isAnyExtension: (obj: object) => obj is AnyExtension;

function load

load: (
    filename: string | string[],
    options?: Options
) => Promise<PackageDefinition>;

• Load a .proto file with the specified options.

  Parameter filename

  One or multiple file paths to load. Can be an absolute path or relative to an include path.

  Parameter

  options.keepCase Preserve field names. The default is to change them to camel case.

  Parameter

  options.longs The type that should be used to represent long values. Valid options are Number and String. Defaults to a Long object type from a library.

  Parameter

  options.enums The type that should be used to represent enum values. The only valid option is String. Defaults to the numeric value.

  Parameter

  options.bytes The type that should be used to represent bytes values. Valid options are Array and String. The default is to use Buffer.

  Parameter

  options.defaults Set default values on output objects. Defaults to false.

  Parameter

  options.arrays Set empty arrays for missing array values even if defaults is false. Defaults to false.

  Parameter

  options.objects Set empty objects for missing object values even if defaults is false. Defaults to false.

  Parameter

  options.oneofs Set virtual oneof properties to the present field's name

  Parameter

  options.json Represent Infinity and NaN as strings in float fields, and automatically decode google.protobuf.Any values.

  Parameter

  options.includeDirs Paths to search for imported .proto files.

function loadFileDescriptorSetFromBuffer

loadFileDescriptorSetFromBuffer: (
    descriptorSet: Buffer,
    options?: Options
) => PackageDefinition;

function loadFileDescriptorSetFromObject

loadFileDescriptorSetFromObject: (
    descriptorSet: Parameters<typeof descriptor.FileDescriptorSet.fromObject>[0],
    options?: Options
) => PackageDefinition;

function loadSync

loadSync: (filename: string | string[], options?: Options) => PackageDefinition;

type AnyDefinition

type AnyDefinition =
    | ServiceDefinition
    | MessageTypeDefinition<object, object>
    | EnumTypeDefinition;

type Options

type Options = Protobuf.IParseOptions &
    Protobuf.IConversionOptions & {
        includeDirs?: string[];
    };