Skip to content

Commit b8c3a4e

Browse files
committed
style: add return type to method signatures.
1 parent 5b637ea commit b8c3a4e

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

src/dynamicBuffer.ts

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ export class DynamicBuffer {
135135
data: string,
136136
lengthParam?: number | BufferEncoding,
137137
encodingParam?: BufferEncoding | number,
138-
) {
138+
): number {
139139
let length: number | undefined;
140140
let encoding: BufferEncoding | undefined;
141141

@@ -178,7 +178,7 @@ export class DynamicBuffer {
178178
offset: number = 0,
179179
length: number = data.length,
180180
encoding: BufferEncoding | undefined = this.encoding,
181-
) {
181+
): number {
182182
if (offset < 0) {
183183
throw new RangeError('The value of "offset" is out of range.');
184184
}
@@ -202,7 +202,7 @@ export class DynamicBuffer {
202202
* between 0 and `this.length - `, default `0`.
203203
* @returns The byte at the position in the buffer.
204204
*/
205-
read(offset: number = 0) {
205+
read(offset: number = 0): number {
206206
if (!this.buffer || offset < 0 || offset >= this.used) {
207207
throw new RangeError(`The value of "offset" is out of range. It must be >= 0 and <= ${
208208
this.used - 1
@@ -270,7 +270,7 @@ export class DynamicBuffer {
270270
* @param end The byte offset to stop coping at (not inclusive), default used bytes offset.
271271
* @returns The new buffer contains the written data in this buffer.
272272
*/
273-
toBuffer(start: number = 0, end: number = this.used) {
273+
toBuffer(start: number = 0, end: number = this.used): Buffer {
274274
if (!this.buffer || this.used === 0) {
275275
return Buffer.alloc(0);
276276
}
@@ -304,7 +304,7 @@ export class DynamicBuffer {
304304
encoding: BufferEncoding | undefined = this.encoding,
305305
start: number = 0,
306306
end: number = this.used,
307-
) {
307+
): string {
308308
if (!this.buffer || this.used === 0) {
309309
return '';
310310
}
@@ -327,7 +327,7 @@ export class DynamicBuffer {
327327
* // {"type":"Buffer","data":[72,101,108,108,111]}
328328
* ```
329329
*/
330-
toJSON() {
330+
toJSON(): { type: string, data: number[] } {
331331
const data: number[] = [];
332332

333333
if (this.buffer && this.used > 0) {
@@ -492,7 +492,7 @@ export class DynamicBuffer {
492492
targetEnd: number = target.length,
493493
sourceStart: number = 0,
494494
sourceEnd: number = this.length,
495-
) {
495+
): number {
496496
const otherBuf = target instanceof DynamicBuffer ? (target.buffer || ([] as number[])) : target;
497497
const thisBuf = this.buffer || ([] as number[]);
498498

@@ -537,7 +537,7 @@ export class DynamicBuffer {
537537
* to compare this buffer.
538538
* @returns `true` if two buffers have exactly the same bytes, `false` otherwise.
539539
*/
540-
equals(otherBuffer: DynamicBuffer | Buffer | Uint8Array) {
540+
equals(otherBuffer: DynamicBuffer | Buffer | Uint8Array): boolean {
541541
return this.compare(otherBuffer, 0, otherBuffer.length, 0, this.length) === 0;
542542
}
543543

@@ -550,7 +550,12 @@ export class DynamicBuffer {
550550
* @param encoding The character encoding to use, default from buffer encoding.
551551
* @returns Number of bytes written.
552552
*/
553-
private writeData(data: string, offset: number, length?: number, encoding?: BufferEncoding) {
553+
private writeData(
554+
data: string,
555+
offset: number,
556+
length?: number,
557+
encoding?: BufferEncoding,
558+
): number {
554559
if (typeof data !== 'string') {
555560
throw new TypeError('argument must be a string');
556561
}
@@ -576,7 +581,7 @@ export class DynamicBuffer {
576581
*
577582
* @param expectSize The number of bytes that minimum size is expected.
578583
*/
579-
private ensureSize(expectSize: number) {
584+
private ensureSize(expectSize: number): void {
580585
if (this.size >= expectSize) {
581586
return;
582587
}
@@ -603,7 +608,7 @@ export class DynamicBuffer {
603608
*
604609
* @param newSize The size of new buffer.
605610
*/
606-
private resize(newSize: number) {
611+
private resize(newSize: number): void {
607612
const newBuffer = Buffer.alloc(newSize, this.fill, this.encoding);
608613

609614
if (this.buffer && this.used > 0) {
@@ -621,7 +626,13 @@ export class DynamicBuffer {
621626
* @param end The end byte offset, default used bytes offset.
622627
* @returns The start and end byte offsets.
623628
*/
624-
private calculateOffsets(start?: number, end?: number) {
629+
private calculateOffsets(
630+
start?: number,
631+
end?: number,
632+
): {
633+
startOffset: number,
634+
endOffset: number,
635+
} {
625636
let startOffset = start;
626637
let endOffset = end;
627638

0 commit comments

Comments
 (0)