Skip to content

Improve types #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Improve types #223

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6f3f37e
Improve types
mohd-akram Oct 3, 2022
41dec50
refactor: enable some `compilerOptions` for safety
yuhr Dec 16, 2022
e496631
refactor: merge properties of inferred type for better IntelliSense r…
yuhr Dec 16, 2022
90abb11
fix: remove invalid signature of methods
yuhr Dec 16, 2022
9dfc35e
refactor: use singular name for union types
yuhr Dec 16, 2022
bf75d53
fix: remove invalid variant of `ComplexType`
yuhr Dec 16, 2022
3b7ff37
refactor: remove unneccessary type coercion
yuhr Dec 16, 2022
698b974
fix: add missing default value for `options` parameter
yuhr Dec 16, 2022
28aa1a7
refactor: enhance types
yuhr Dec 16, 2022
0cf63cb
fix: enhance types
yuhr Dec 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 3 additions & 43 deletions lib/binary_parser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ export class Parser<O = {}> {

private primitiveN<N extends string, F = number>(
type: PrimitiveTypes,
varName: N | undefined,
varName: N,
options: ParserOptions<O, number, F>
): Next<O, N, F> {
return this.setNextParser(type as Types, varName, options);
Expand All @@ -325,25 +325,15 @@ export class Parser<O = {}> {
return (type + this.endian.toLowerCase()) as PrimitiveTypes;
}

uint8(): Next<O, unknown, number>;
uint8<N extends string, F = number>(
varName: N,
options?: ParserOptions<O, number, F>
): Next<O, N, F>;
uint8<N extends string, F = number>(
varName?: N,
options: ParserOptions<O, number, F> = {}
): Next<O, N, F> {
return this.primitiveN("uint8", varName, options);
}

uint16(): Next<O, unknown, number>;
Copy link
Contributor Author

@mohd-akram mohd-akram Dec 19, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no other way to get a uint16 parser without explicitly specifying endianness. This is useful in choice:

choices: {
  0: Parser.start().uint16(), // "uint16" doesn't work
  1: Parser.start().uint32(), // "uint32" doesn't work
}

uint16<N extends string, F = number>(
varName: N,
options?: ParserOptions<O, number, F>
): Next<O, N, F>;
uint16<N extends string, F = number>(
varName?: N,
options: ParserOptions<O, number, F> = {}
): Next<O, N, F> {
return this.primitiveN(this.useThisEndian("uint16"), varName, options);
Expand All @@ -363,13 +353,8 @@ export class Parser<O = {}> {
return this.primitiveN("uint16be", varName, options);
}

uint32(): Next<O, unknown, number>;
uint32<N extends string, F = number>(
varName: N,
options?: ParserOptions<O, number, F>
): Next<O, N, F>;
uint32<N extends string, F = number>(
varName?: N,
options: ParserOptions<O, number, F> = {}
): Next<O, N, F> {
return this.primitiveN(this.useThisEndian("uint32"), varName, options);
Expand All @@ -389,25 +374,15 @@ export class Parser<O = {}> {
return this.primitiveN("uint32be", varName, options);
}

int8(): Next<O, unknown, number>;
int8<N extends string, F = number>(
varName: N,
options?: ParserOptions<O, number, F>
): Next<O, N, F>;
int8<N extends string, F = number>(
varName?: N,
options: ParserOptions<O, number, F> = {}
): Next<O, N, F> {
return this.primitiveN("int8", varName, options);
}

int16(): Next<O, unknown, number>;
int16<N extends string, F = number>(
varName: N,
options?: ParserOptions<O, number, F>
): Next<O, N, F>;
int16<N extends string, F = number>(
varName?: N,
options: ParserOptions<O, number, F> = {}
): Next<O, N, F> {
return this.primitiveN(this.useThisEndian("int16"), varName, options);
Expand All @@ -427,13 +402,8 @@ export class Parser<O = {}> {
return this.primitiveN("int16be", varName, options);
}

int32(): Next<O, unknown, number>;
int32<N extends string, F = number>(
varName: N,
options?: ParserOptions<O, number, F>
): Next<O, N, F>;
int32<N extends string, F = number>(
varName?: N,
options: ParserOptions<O, number, F> = {}
): Next<O, N, F> {
return this.primitiveN(this.useThisEndian("int32"), varName, options);
Expand All @@ -458,13 +428,8 @@ export class Parser<O = {}> {
throw new Error("BigInt64 is unsupported on this runtime");
}

int64(): Next<O, unknown, number>;
int64<N extends string, F = number>(
varName: N,
options?: ParserOptions<O, number, F>
): Next<O, N, F>;
int64<N extends string, F = number>(
varName?: N,
options: ParserOptions<O, number, F> = {}
): Next<O, N, F> {
this.bigIntVersionCheck();
Expand All @@ -487,13 +452,8 @@ export class Parser<O = {}> {
return this.primitiveN("int64le", varName, options);
}

uint64(): Next<O, unknown, number>;
uint64<N extends string, F = number>(
varName: N,
options?: ParserOptions<O, number, F>
): Next<O, N, F>;
uint64<N extends string, F = number>(
varName?: N,
options: ParserOptions<O, number, F> = {}
): Next<O, N, F> {
this.bigIntVersionCheck();
Expand Down Expand Up @@ -1192,13 +1152,13 @@ export class Parser<O = {}> {

private setNextParser<N extends string, T, F>(
type: Types,
varName: N | undefined,
varName: N,
options: ParserOptions<O, T, F>
): Next<O, N, F> {
const parser = new Parser();

parser.type = type;
parser.varName = varName as string;
parser.varName = varName;
parser.options = options as ParserOptions;
parser.endian = this.endian;

Expand Down