utilium 0.3.0 → 0.3.1

package/dist/struct.d.ts

@@ -1,16 +1,42 @@
 import { ClassLike } from './types.js';
 export type PrimitiveType = `${'int' | 'uint'}${8 | 16 | 32 | 64}` | `float${32 | 64}`;
 export type ValidPrimitiveType = PrimitiveType | Capitalize<PrimitiveType> | 'char';
+/**
+ * Options for struct initialization
+ */
 export interface StructOptions {
     align: number;
     bigEndian: boolean;
 }
+/**
+ * Gets the size in bytes of a type
+ */
 export declare function sizeof(type: ValidPrimitiveType | ClassLike | object): number;
+/**
+ * Aligns a number
+ */
 export declare function align(value: number, alignment: number): number;
+/**
+ * Decorates a class as a struct
+ */
 export declare function struct(options?: Partial<StructOptions>): (target: ClassLike, _?: ClassDecoratorContext) => void;
+/**
+ * Decorates a class member to be serialized
+ */
 export declare function member(type: ValidPrimitiveType | ClassLike, length?: number): (target: object, context?: ClassMemberDecoratorContext | string | symbol) => void;
+/**
+ * Serializes a struct into a Uint8Array
+ */
 export declare function serialize(instance: unknown): Uint8Array;
-export declare function deserialize(instance: unknown, _buffer: Uint8Array): void;
+/**
+ * Deserializes a struct from a Uint8Array
+ */
+export declare function deserialize(instance: unknown, _buffer: ArrayBuffer | ArrayBufferView): void;
+/**
+ * Shortcut types
+ *
+ * Instead of writing `@member(type)` you can write `@types.type`, or `@types.type(length)` for arrays
+ */
 export declare const types: {
     int8: {
         (length?: number): (target: object, context?: string | symbol | ClassMemberDecoratorContext) => void;

package/dist/struct.js

@@ -22,6 +22,9 @@ function isInstance(arg) {
 function isStruct(arg) {
     return isInstance(arg) || isStatic(arg);
 }
+/**
+ * Gets the size in bytes of a type
+ */
 export function sizeof(type) {
     // primitive
     if (typeof type == 'string') {
@@ -36,9 +39,15 @@ export function sizeof(type) {
     const meta = metadata in type ? type[metadata] : type.constructor[metadata];
     return meta.size;
 }
+/**
+ * Aligns a number
+ */
 export function align(value, alignment) {
     return Math.ceil(value / alignment) * alignment;
 }
+/**
+ * Decorates a class as a struct
+ */
 export function struct(options = {}) {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     return function (target, _) {
@@ -61,6 +70,9 @@ export function struct(options = {}) {
         delete target[init];
     };
 }
+/**
+ * Decorates a class member to be serialized
+ */
 export function member(type, length) {
     return function (target, context) {
         var _a;
@@ -73,6 +85,9 @@ export function member(type, length) {
         target.constructor[init].push({ name, type, length });
     };
 }
+/**
+ * Serializes a struct into a Uint8Array
+ */
 export function serialize(instance) {
     if (!isInstance(instance)) {
         throw new TypeError('Can not serialize, not a struct instance');
@@ -106,6 +121,9 @@ export function serialize(instance) {
     }
     return buffer;
 }
+/**
+ * Deserializes a struct from a Uint8Array
+ */
 export function deserialize(instance, _buffer) {
     if (!isInstance(instance)) {
         throw new TypeError('Can not deserialize, not a struct instance');
@@ -154,4 +172,9 @@ function _member(type) {
     }
     return _;
 }
+/**
+ * Shortcut types
+ *
+ * Instead of writing `@member(type)` you can write `@types.type`, or `@types.type(length)` for arrays
+ */
 export const types = Object.fromEntries(validPrimitiveTypes.map(t => [t, _member(t)]));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "utilium",
-	"version": "0.3.0",
+	"version": "0.3.1",
 	"description": "Typescript utilies",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/src/struct.ts

@@ -30,6 +30,9 @@ interface MemberInit {
 
 const init = Symbol('struct_init');
 
+/**
+ * Options for struct initialization
+ */
 export interface StructOptions {
 	align: number;
 	bigEndian: boolean;
@@ -71,6 +74,9 @@ function isStruct(arg: unknown): arg is Instance | Static {
 	return isInstance(arg) || isStatic(arg);
 }
 
+/**
+ * Gets the size in bytes of a type
+ */
 export function sizeof(type: ValidPrimitiveType | ClassLike | object): number {
 	// primitive
 	if (typeof type == 'string') {
@@ -89,10 +95,16 @@ export function sizeof(type: ValidPrimitiveType | ClassLike | object): number {
 	return meta.size;
 }
 
+/**
+ * Aligns a number
+ */
 export function align(value: number, alignment: number): number {
 	return Math.ceil(value / alignment) * alignment;
 }
 
+/**
+ * Decorates a class as a struct
+ */
 export function struct(options: Partial<StructOptions> = {}) {
 	// eslint-disable-next-line @typescript-eslint/no-unused-vars
 	return function (target: ClassLike, _?: ClassDecoratorContext) {
@@ -117,6 +129,9 @@ export function struct(options: Partial<StructOptions> = {}) {
 	};
 }
 
+/**
+ * Decorates a class member to be serialized
+ */
 export function member(type: ValidPrimitiveType | ClassLike, length?: number) {
 	return function (target: object, context?: ClassMemberDecoratorContext | string | symbol) {
 		let name = typeof context == 'object' ? context.name : context;
@@ -130,6 +145,9 @@ export function member(type: ValidPrimitiveType | ClassLike, length?: number) {
 	};
 }
 
+/**
+ * Serializes a struct into a Uint8Array
+ */
 export function serialize(instance: unknown): Uint8Array {
 	if (!isInstance(instance)) {
 		throw new TypeError('Can not serialize, not a struct instance');
@@ -172,7 +190,10 @@ export function serialize(instance: unknown): Uint8Array {
 	return buffer;
 }
 
-export function deserialize(instance: unknown, _buffer: Uint8Array) {
+/**
+ * Deserializes a struct from a Uint8Array
+ */
+export function deserialize(instance: unknown, _buffer: ArrayBuffer | ArrayBufferView) {
 	if (!isInstance(instance)) {
 		throw new TypeError('Can not deserialize, not a struct instance');
 	}
@@ -235,4 +256,9 @@ function _member<T extends ValidPrimitiveType>(type: T) {
 	return _;
 }
 
+/**
+ * Shortcut types
+ *
+ * Instead of writing `@member(type)` you can write `@types.type`, or `@types.type(length)` for arrays
+ */
 export const types = Object.fromEntries(validPrimitiveTypes.map(t => [t, _member(t)])) as { [K in ValidPrimitiveType]: ReturnType<typeof _member<K>> };