Skip to content

TypeScript d.ts Message does not include cloneMessage module #162

@jcollins-axway

Description

@jcollins-axway

When generating TypeScript d.ts files from the proto files the cloneMessage module, implemented on the jspb.Message, is not added.

cloneMessage should be added as a default method for every Message object created. Can be added with other methods like serializeBinary and toObject.

current

export class GenericMessage extends jspb.Message {
	getName(): string;
	setName(value: string): void;

	serializeBinary(): Uint8Array;
	toObject(includeInstance?: boolean): GenericMessage.AsObject;
	static toObject(includeInstance: boolean, msg: GenericMessage): GenericMessage.AsObject;
	static extensions: { [key: number]: jspb.ExtensionFieldInfo<jspb.Message> };
	static extensionsBinary: { [key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message> };
	static serializeBinaryToWriter(message: GenericMessage, writer: jspb.BinaryWriter): void;
	static deserializeBinary(bytes: Uint8Array): GenericMessage;
	static deserializeBinaryFromReader(message: GenericMessage, reader: jspb.BinaryReader): GenericMessage;
}

expected

export class GenericMessage extends jspb.Message {
	getName(): string;
	setName(value: string): void;

	cloneMessage(): GenericMessage;
	serializeBinary(): Uint8Array;
	toObject(includeInstance?: boolean): GenericMessage.AsObject;
	static toObject(includeInstance: boolean, msg: GenericMessage): GenericMessage.AsObject;
	static extensions: { [key: number]: jspb.ExtensionFieldInfo<jspb.Message> };
	static extensionsBinary: { [key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message> };
	static serializeBinaryToWriter(message: GenericMessage, writer: jspb.BinaryWriter): void;
	static deserializeBinary(bytes: Uint8Array): GenericMessage;
	static deserializeBinaryFromReader(message: GenericMessage, reader: jspb.BinaryReader): GenericMessage;
}

Allowing users of the library to use

// index.ts
import * as messages from './generated/generic_pb';
const gm1 = new messages.GenericMessage();
let gm2 = gm1.cloneMessage();  //  <-- currently an error when running tsc

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions