refactor: make the endianess util constant (#7)

denosaurs · Feb 27, 2023 · 62a5190 · 62a5190
1 parent f04c2f4
commit 62a5190
Show file tree

Hide file tree

Showing 14 changed files with 23 additions and 44 deletions.
diff --git a/.github/workflows/depsbot.yml b/.github/workflows/depsbot.yml
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2022 the denosaurs team
+Copyright (c) 2021-2023 the denosaurs team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
 # byte_type
 
 [![Tags](https://img.shields.io/github/release/denosaurs/byte_type)](https://github.com/denosaurs/byte_type/releases)
-[![CI Status](https://img.shields.io/github/workflow/status/denosaurs/byte_type/check)](https://github.com/denosaurs/byte_type/actions)
-[![Dependencies](https://img.shields.io/github/workflow/status/denosaurs/byte_type/depsbot?label=dependencies)](https://github.com/denosaurs/depsbot)
+[![Checks](https://img.shields.io/github/actions/workflow/status/denosaurs/byte_type/checks.yml?branch=main)](https://github.com/denosaurs/byte_type/actions)
 [![License](https://img.shields.io/github/license/denosaurs/byte_type)](https://github.com/denosaurs/byte_type/blob/master/LICENSE)
 
-`byte_type` is a small helper module for working with different raw types
-represented as a bunch of bytes.
+`byte_type` is a small helper module for efficiently working with different raw
+types represented as a bunch of bytes. Now with performance being close to
+native js performance and ergonomic interfaces!
 
 ## Usage
 
@@ -33,4 +33,4 @@ Pull request, issues and feedback are very welcome. Code style is formatted with
 
 ### Licence
 
-Copyright 2021, the denosaurs team. All rights reserved. MIT license.
+Copyright 2021-2023, the denosaurs team. All rights reserved. MIT license.
diff --git a/types/mod.ts b/types/mod.ts
@@ -1,6 +1,8 @@
 export * from "./array/mod.ts";
 export * from "./bitflags/mod.ts";
+export * from "./misc/mod.ts";
 export * from "./primitive/mod.ts";
 export * from "./string/mod.ts";
 export * from "./struct/mod.ts";
 export * from "./tuple/mod.ts";
+export * from "./types.ts";
diff --git a/types/primitive/f32.ts b/types/primitive/f32.ts
@@ -6,7 +6,7 @@ export class F32 implements AlignedType<number> {
   byteAlign = 4;
   endian;
 
-  constructor(endian: boolean = endianess()) {
+  constructor(endian: boolean = endianess) {
     this.endian = endian;
   }
 

diff --git a/types/primitive/f64.ts b/types/primitive/f64.ts
@@ -6,7 +6,7 @@ export class F64 implements AlignedType<number> {
   byteAlign = 8;
   endian;
 
-  constructor(endian: boolean = endianess()) {
+  constructor(endian: boolean = endianess) {
     this.endian = endian;
   }
 

diff --git a/types/primitive/i16.ts b/types/primitive/i16.ts
@@ -6,7 +6,7 @@ export class I16 implements AlignedType<number> {
   byteAlign = 2;
   endian;
 
-  constructor(endian: boolean = endianess()) {
+  constructor(endian: boolean = endianess) {
     this.endian = endian;
   }
 

diff --git a/types/primitive/i32.ts b/types/primitive/i32.ts
@@ -6,7 +6,7 @@ export class I32 implements AlignedType<number> {
   byteAlign = 4;
   endian;
 
-  constructor(endian: boolean = endianess()) {
+  constructor(endian: boolean = endianess) {
     this.endian = endian;
   }
 

diff --git a/types/primitive/i64.ts b/types/primitive/i64.ts
@@ -6,7 +6,7 @@ export class I64 implements AlignedType<bigint> {
   byteAlign = 8;
   endian;
 
-  constructor(endian: boolean = endianess()) {
+  constructor(endian: boolean = endianess) {
     this.endian = endian;
   }
 

diff --git a/types/primitive/u16.ts b/types/primitive/u16.ts
@@ -6,7 +6,7 @@ export class U16 implements AlignedType<number> {
   byteAlign = 2;
   endian;
 
-  constructor(endian: boolean = endianess()) {
+  constructor(endian: boolean = endianess) {
     this.endian = endian;
   }
 

diff --git a/types/primitive/u32.ts b/types/primitive/u32.ts
@@ -6,7 +6,7 @@ export class U32 implements AlignedType<number> {
   byteAlign = 4;
   endian;
 
-  constructor(endian: boolean = endianess()) {
+  constructor(endian: boolean = endianess) {
     this.endian = endian;
   }
 

diff --git a/types/primitive/u64.ts b/types/primitive/u64.ts
@@ -6,7 +6,7 @@ export class U64 implements AlignedType<bigint> {
   byteAlign = 8;
   endian;
 
-  constructor(endian: boolean = endianess()) {
+  constructor(endian: boolean = endianess) {
     this.endian = endian;
   }
 

diff --git a/util.ts b/util.ts
diff --git a/utils.ts b/utils.ts
@@ -0,0 +1,7 @@
+const buffer = new ArrayBuffer(2);
+new DataView(buffer).setInt16(0, 256, true);
+
+/**
+ * The endianess of your machine, true if little endian and false if big endian.
+ */
+export const endianess = new Int16Array(buffer)[0] === 256;