pdf-lite 1.0.0 → 1.0.1-alpha.2

package/docs/utils/assert/functions/assert.md

@@ -0,0 +1,39 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/assert](../README.md) / assert
+
+# Function: assert()
+
+> **assert**(`value`, `message?`): `asserts value`
+
+Asserts that a value is truthy, throwing an error if it is not.
+
+## Parameters
+
+### value
+
+`unknown`
+
+The value to check.
+
+### message?
+
+`string`
+
+Optional error message to throw if the assertion fails.
+
+## Returns
+
+`asserts value`
+
+## Throws
+
+Error if the value is falsy.
+
+## Example
+
+```typescript
+assert(user !== null, 'User must be defined')
+```

package/docs/utils/assert/functions/assertIfDefined.md

@@ -0,0 +1,46 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/assert](../README.md) / assertIfDefined
+
+# Function: assertIfDefined()
+
+> **assertIfDefined**(`value`, `condition`, `message?`): `asserts condition`
+
+Conditionally asserts a condition only when a value is defined.
+Does nothing if the value is undefined or null.
+
+## Parameters
+
+### value
+
+`unknown`
+
+The value to check for definedness.
+
+### condition
+
+`unknown`
+
+The condition to assert if value is defined.
+
+### message?
+
+`string`
+
+Optional error message to throw if the assertion fails.
+
+## Returns
+
+`asserts condition`
+
+## Throws
+
+Error if value is defined and condition is falsy.
+
+## Example
+
+```typescript
+assertIfDefined(user, user?.age >= 18, 'User must be an adult')
+```

package/docs/utils/bytesToHex/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / utils/bytesToHex
+
+# utils/bytesToHex
+
+## Functions
+
+- [bytesToHex](functions/bytesToHex.md)

package/docs/utils/bytesToHex/functions/bytesToHex.md

@@ -0,0 +1,31 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/bytesToHex](../README.md) / bytesToHex
+
+# Function: bytesToHex()
+
+> **bytesToHex**(`bytes`): `string`
+
+Converts a byte array to a hexadecimal string.
+
+## Parameters
+
+### bytes
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The byte array to convert.
+
+## Returns
+
+`string`
+
+A hexadecimal string representation of the bytes.
+
+## Example
+
+```typescript
+bytesToHex(new Uint8Array([255, 0, 127])) // Returns 'FF007F'
+```

package/docs/utils/bytesToHexBytes/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / utils/bytesToHexBytes
+
+# utils/bytesToHexBytes
+
+## Functions
+
+- [bytesToHexBytes](functions/bytesToHexBytes.md)

package/docs/utils/bytesToHexBytes/functions/bytesToHexBytes.md

@@ -0,0 +1,32 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/bytesToHexBytes](../README.md) / bytesToHexBytes
+
+# Function: bytesToHexBytes()
+
+> **bytesToHexBytes**(`bytes`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+Converts a byte array to a byte array containing hexadecimal character codes.
+Each byte becomes two bytes representing its hex digits.
+
+## Parameters
+
+### bytes
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The byte array to convert.
+
+## Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+A byte array with hexadecimal character codes.
+
+## Example
+
+```typescript
+bytesToHexBytes(new Uint8Array([255])) // Returns bytes for 'FF'
+```

package/docs/utils/bytesToString/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / utils/bytesToString
+
+# utils/bytesToString
+
+## Functions
+
+- [bytesToString](functions/bytesToString.md)

package/docs/utils/bytesToString/functions/bytesToString.md

@@ -0,0 +1,31 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/bytesToString](../README.md) / bytesToString
+
+# Function: bytesToString()
+
+> **bytesToString**(`bytes`): `string`
+
+Converts a byte array to a string using UTF-8 decoding.
+
+## Parameters
+
+### bytes
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The byte array to decode.
+
+## Returns
+
+`string`
+
+The decoded string.
+
+## Example
+
+```typescript
+bytesToString(new Uint8Array([72, 101, 108, 108, 111])) // Returns 'Hello'
+```

package/docs/utils/concatUint8Arrays/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / utils/concatUint8Arrays
+
+# utils/concatUint8Arrays
+
+## Functions
+
+- [concatUint8Arrays](functions/concatUint8Arrays.md)

package/docs/utils/concatUint8Arrays/functions/concatUint8Arrays.md

@@ -0,0 +1,31 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/concatUint8Arrays](../README.md) / concatUint8Arrays
+
+# Function: concatUint8Arrays()
+
+> **concatUint8Arrays**(...`arrays`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+Concatenates multiple Uint8Array instances into a single ByteArray.
+
+## Parameters
+
+### arrays
+
+...`Uint8Array`\<`ArrayBufferLike`\>[]
+
+The arrays to concatenate.
+
+## Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+A new ByteArray containing all input arrays concatenated in order.
+
+## Example
+
+```typescript
+const result = concatUint8Arrays(new Uint8Array([1, 2]), new Uint8Array([3, 4])) // Returns Uint8Array([1, 2, 3, 4])
+```

package/docs/utils/escapeString/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / utils/escapeString
+
+# utils/escapeString
+
+## Functions
+
+- [escapeString](functions/escapeString.md)

package/docs/utils/escapeString/functions/escapeString.md

@@ -0,0 +1,32 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/escapeString](../README.md) / escapeString
+
+# Function: escapeString()
+
+> **escapeString**(`bytes`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+Escapes special characters in a PDF string according to PDF specification.
+Escapes parentheses, backslashes, line feeds, and carriage returns.
+
+## Parameters
+
+### bytes
+
+The byte array or string to escape.
+
+`string` | [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+## Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+A new byte array with escaped characters.
+
+## Example
+
+```typescript
+escapeString('Hello (World)') // Escapes the parentheses
+```

package/docs/utils/hexBytesToBytes/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / utils/hexBytesToBytes
+
+# utils/hexBytesToBytes
+
+## Functions
+
+- [hexBytesToBytes](functions/hexBytesToBytes.md)

package/docs/utils/hexBytesToBytes/functions/hexBytesToBytes.md

@@ -0,0 +1,33 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/hexBytesToBytes](../README.md) / hexBytesToBytes
+
+# Function: hexBytesToBytes()
+
+> **hexBytesToBytes**(`hex`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+Converts a byte array containing hexadecimal ASCII characters to raw bytes.
+Each pair of hex character bytes is converted to a single byte value.
+
+## Parameters
+
+### hex
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The byte array containing hex character codes.
+
+## Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+A byte array with decoded values.
+
+## Example
+
+```typescript
+// 'FF' as bytes (0x46, 0x46) becomes 0xFF
+hexBytesToBytes(new Uint8Array([70, 70])) // Returns Uint8Array([255])
+```

package/docs/utils/hexBytesToString/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / utils/hexBytesToString
+
+# utils/hexBytesToString
+
+## Functions
+
+- [hexBytesToString](functions/hexBytesToString.md)

package/docs/utils/hexBytesToString/functions/hexBytesToString.md

@@ -0,0 +1,31 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/hexBytesToString](../README.md) / hexBytesToString
+
+# Function: hexBytesToString()
+
+> **hexBytesToString**(`bytes`): `string`
+
+Converts a byte array to a lowercase hexadecimal string.
+
+## Parameters
+
+### bytes
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The byte array to convert.
+
+## Returns
+
+`string`
+
+A lowercase hexadecimal string representation.
+
+## Example
+
+```typescript
+hexBytesToString(new Uint8Array([255, 0])) // Returns 'ff00'
+```

package/docs/utils/hexToBytes/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / utils/hexToBytes
+
+# utils/hexToBytes
+
+## Functions
+
+- [hexToBytes](functions/hexToBytes.md)

package/docs/utils/hexToBytes/functions/hexToBytes.md

@@ -0,0 +1,31 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/hexToBytes](../README.md) / hexToBytes
+
+# Function: hexToBytes()
+
+> **hexToBytes**(`hex`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+Converts a hexadecimal string to a byte array.
+
+## Parameters
+
+### hex
+
+`string`
+
+The hexadecimal string to convert.
+
+## Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+A byte array containing the decoded values.
+
+## Example
+
+```typescript
+hexToBytes('FF00') // Returns Uint8Array([255, 0])
+```

package/docs/utils/padBytes/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / utils/padBytes
+
+# utils/padBytes
+
+## Functions
+
+- [padBytes](functions/padBytes.md)

package/docs/utils/padBytes/functions/padBytes.md

@@ -0,0 +1,41 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [utils/padBytes](../README.md) / padBytes
+
+# Function: padBytes()
+
+> **padBytes**(`bytes`, `length`): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+Pads a byte array to a specified length with trailing zeros.
+
+## Parameters
+
+### bytes
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+The byte array to pad.
+
+### length
+
+`number`
+
+The target length for the padded array.
+
+## Returns
+
+[`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+A new byte array padded to the specified length.
+
+## Throws
+
+Error if the input array is already longer than the target length.
+
+## Example
+
+```typescript
+padBytes(new Uint8Array([1, 2]), 4) // Returns Uint8Array([1, 2, 0, 0])
+```

package/docs/utils/predictors/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / utils/predictors
+
+# utils/predictors
+
+## Classes
+
+- [Predictor](classes/Predictor.md)