npm - pdf-lite - Versions diffs - 1.0.1-alpha.2 → 1.0.1 - Mend

pdf-lite 1.0.1-alpha.2 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (721) hide show

package/docs/core/objects/pdf-xref-table/classes/PdfXRefTableSectionHeader.md DELETED Viewed

@@ -1,277 +0,0 @@
-[**pdf-lite**](../../../../README.md)
----
-[pdf-lite](../../../../README.md) / [core/objects/pdf-xref-table](../README.md) / PdfXRefTableSectionHeader
-# Class: PdfXRefTableSectionHeader
-## Extends
-- [`PdfObject`](../../pdf-object/classes/PdfObject.md)
-## Constructors
-### Constructor
-> **new PdfXRefTableSectionHeader**(`options`): `PdfXRefTableSectionHeader`
-#### Parameters
-##### options
-###### entryCount
-`number` \| [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)
-###### startObjectNumber
-`number` \| [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)
-#### Returns
-`PdfXRefTableSectionHeader`
-#### Overrides
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`constructor`](../../pdf-object/classes/PdfObject.md#constructor)
-## Properties
-### entryCount
-> **entryCount**: [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)
----
-### modified
-> `protected` **modified**: `boolean` = `true`
-Indicates whether the object has been modified. By default, assume it has been modified because it's a new object
-#### Inherited from
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`modified`](../../pdf-object/classes/PdfObject.md#modified)
----
-### postTokens?
-> `optional` **postTokens**: [`PdfToken`](../../../tokens/token/classes/PdfToken.md)[]
-Optional tokens to prepend or append during serialization
-#### Inherited from
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`postTokens`](../../pdf-object/classes/PdfObject.md#posttokens)
----
-### preTokens?
-> `optional` **preTokens**: [`PdfToken`](../../../tokens/token/classes/PdfToken.md)[]
-Optional tokens to prepend or append during serialization
-#### Inherited from
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`preTokens`](../../pdf-object/classes/PdfObject.md#pretokens)
----
-### startObjectNumber
-> **startObjectNumber**: [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)
-## Accessors
-### objectType
-#### Get Signature
-> **get** **objectType**(): `string`
-The type of this PDF object
-##### Returns
-`string`
-#### Inherited from
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`objectType`](../../pdf-object/classes/PdfObject.md#objecttype)
-## Methods
-### as()
-> **as**\<`T`\>(`ctor`): `T`
-Attempts to cast the object to a specific PdfObject subclass
-#### Type Parameters
-##### T
-`T` _extends_ [`PdfObject`](../../pdf-object/classes/PdfObject.md)
-#### Parameters
-##### ctor
-(...`args`) => `T`
-#### Returns
-`T`
-#### Inherited from
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`as`](../../pdf-object/classes/PdfObject.md#as)
----
-### clone()
-> **clone**(): `this`
-Creates a deep clone of the object
-#### Returns
-`this`
-#### Overrides
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`clone`](../../pdf-object/classes/PdfObject.md#clone)
----
-### equals()
-> **equals**(`other?`): `boolean`
-Compares this object to another for equality based on their token representations
-#### Parameters
-##### other?
-[`PdfObject`](../../pdf-object/classes/PdfObject.md)
-#### Returns
-`boolean`
-#### Inherited from
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`equals`](../../pdf-object/classes/PdfObject.md#equals)
----
-### isModified()
-> **isModified**(): `boolean`
-Indicates whether the object has been modified. Override this method if the modified state is determined differently
-#### Returns
-`boolean`
-#### Inherited from
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`isModified`](../../pdf-object/classes/PdfObject.md#ismodified)
----
-### setModified()
-> **setModified**(`modified`): `void`
-Sets the modified state of the object. Override this method if the modified state is determined differently
-#### Parameters
-##### modified
-`boolean` = `true`
-#### Returns
-`void`
-#### Inherited from
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`setModified`](../../pdf-object/classes/PdfObject.md#setmodified)
----
-### toBytes()
-> **toBytes**(`padTo?`): [`ByteArray`](../../../../types/type-aliases/ByteArray.md)
-Converts the object to a ByteArray, optionally padding to a specified length
-#### Parameters
-##### padTo?
-`number`
-#### Returns
-[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
-#### Inherited from
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`toBytes`](../../pdf-object/classes/PdfObject.md#tobytes)
----
-### tokenize()
-> `protected` **tokenize**(): [`PdfXRefTableSectionStartToken`](../../../tokens/xref-table-section-start-token/classes/PdfXRefTableSectionStartToken.md)[]
-Tokenizes the object into an array of PdfTokens
-#### Returns
-[`PdfXRefTableSectionStartToken`](../../../tokens/xref-table-section-start-token/classes/PdfXRefTableSectionStartToken.md)[]
-#### Overrides
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`tokenize`](../../pdf-object/classes/PdfObject.md#tokenize)
----
-### toString()
-> **toString**(): `string`
-Converts the object to a string representation
-#### Returns
-`string`
-#### Inherited from
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`toString`](../../pdf-object/classes/PdfObject.md#tostring)
----
-### toTokens()
-> **toTokens**(): [`PdfToken`](../../../tokens/token/classes/PdfToken.md)[]
-Converts the object to an array of PdfTokens, including any pre or post tokens
-#### Returns
-[`PdfToken`](../../../tokens/token/classes/PdfToken.md)[]
-#### Inherited from
-[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`toTokens`](../../pdf-object/classes/PdfObject.md#totokens)

package/docs/core/parser/README.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**pdf-lite**](../../README.md)
----
-[pdf-lite](../../README.md) / core/parser
-# core/parser
-## Classes
-- [Parser](classes/Parser.md)

package/docs/core/parser/classes/Parser.md DELETED Viewed

@@ -1,74 +0,0 @@
-[**pdf-lite**](../../../README.md)
----
-[pdf-lite](../../../README.md) / [core/parser](../README.md) / Parser
-# Abstract Class: Parser\<I, O\>
-Abstract base class for parsers that transform input items to output items.
-Provides a common interface for feeding input and generating output.
-## Extended by
-- [`IncrementalParser`](../../incremental-parser/classes/IncrementalParser.md)
-- [`PdfTokenSerializer`](../../serializer/classes/PdfTokenSerializer.md)
-- [`PdfObjectTokeniser`](../../tokeniser/classes/PdfObjectTokeniser.md)
-## Type Parameters
-### I
-`I`
-The input item type
-### O
-`O`
-The output item type
-## Constructors
-### Constructor
-> **new Parser**\<`I`, `O`\>(): `Parser`\<`I`, `O`\>
-#### Returns
-`Parser`\<`I`, `O`\>
-## Methods
-### feed()
-> `abstract` **feed**(...`input`): `void`
-Feeds input items to the parser.
-#### Parameters
-##### input
-...`I`[]
-Input items to process
-#### Returns
-`void`
----
-### nextItems()
-> `abstract` **nextItems**(): `Generator`\<`O`\>
-Generates output items from the fed input.
-#### Returns
-`Generator`\<`O`\>
-A generator yielding output items

package/docs/core/ref/README.md DELETED Viewed

@@ -1,15 +0,0 @@
-[**pdf-lite**](../../README.md)
----
-[pdf-lite](../../README.md) / core/ref
-# core/ref
-## Classes
-- [Ref](classes/Ref.md)
-## Type Aliases
-- [RefUpdateCallback](type-aliases/RefUpdateCallback.md)

package/docs/core/ref/classes/Ref.md DELETED Viewed

@@ -1,149 +0,0 @@
-[**pdf-lite**](../../../README.md)
----
-[pdf-lite](../../../README.md) / [core/ref](../README.md) / Ref
-# Class: Ref\<T\>
-A mutable reference wrapper that supports value updates and change notifications.
-Can hold a direct value or reference another Ref, forming reference chains.
-## Example
-```typescript
-const ref = new Ref(42)
-ref.onUpdate((old, newVal) => console.log(`Changed from ${old} to ${newVal}`))
-ref.update(100) // Logs: Changed from 42 to 100
-```
-## Type Parameters
-### T
-`T`
-The value type being referenced
-## Constructors
-### Constructor
-> **new Ref**\<`T`\>(`value`): `Ref`\<`T`\>
-Creates a new Ref with an initial value.
-#### Parameters
-##### value
-The initial value or another Ref to chain
-`T` | `Ref`\<`T`\>
-#### Returns
-`Ref`\<`T`\>
-#### Throws
-Error if attempting to create a self-referencing Ref
-## Properties
-### callbacks
-> **callbacks**: [`RefUpdateCallback`](../type-aliases/RefUpdateCallback.md)\<`T`\>[] = `[]`
-Registered callbacks for update notifications
----
-### isModified
-> **isModified**: `boolean` = `false`
----
-### value
-> **value**: `T` \| `Ref`\<`T`\>
-The current value or a reference to another Ref
-## Methods
-### equals()
-> **equals**(`other?`): `boolean`
-Compares this Ref's resolved value with another value or Ref.
-#### Parameters
-##### other?
-The value or Ref to compare against
-`T` | `Ref`\<`T`\>
-#### Returns
-`boolean`
-True if the resolved values are equal
----
-### onUpdate()
-> **onUpdate**(`callback`): `void`
-Registers a callback to be notified when the value changes.
-#### Parameters
-##### callback
-[`RefUpdateCallback`](../type-aliases/RefUpdateCallback.md)\<`T`\>
-The function to call on value updates
-#### Returns
-`void`
----
-### resolve()
-> **resolve**(): `T`
-Resolves the reference chain to get the final value.
-#### Returns
-`T`
-The resolved value of type T
----
-### update()
-> **update**(`newValue`): `void`
-Updates the reference to a new value or another Ref.
-Notifies all registered callbacks of the change.
-#### Parameters
-##### newValue
-The new value or Ref to point to
-`T` | `Ref`\<`T`\>
-#### Returns
-`void`

package/docs/core/ref/type-aliases/RefUpdateCallback.md DELETED Viewed

@@ -1,33 +0,0 @@
-[**pdf-lite**](../../../README.md)
----
-[pdf-lite](../../../README.md) / [core/ref](../README.md) / RefUpdateCallback
-# Type Alias: RefUpdateCallback()\<T\>
-> **RefUpdateCallback**\<`T`\> = (`oldValue`, `newValue`) => `void`
-Callback function type for ref update notifications.
-## Type Parameters
-### T
-`T`
-The value type of the ref
-## Parameters
-### oldValue
-`T`
-### newValue
-`T`
-## Returns
-`void`

package/docs/core/serializer/README.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**pdf-lite**](../../README.md)
----
-[pdf-lite](../../README.md) / core/serializer
-# core/serializer
-## Classes
-- [PdfTokenSerializer](classes/PdfTokenSerializer.md)

package/docs/core/serializer/classes/PdfTokenSerializer.md DELETED Viewed

@@ -1,106 +0,0 @@
-[**pdf-lite**](../../../README.md)
----
-[pdf-lite](../../../README.md) / [core/serializer](../README.md) / PdfTokenSerializer
-# Class: PdfTokenSerializer
-Serializes PDF tokens into a byte stream.
-Handles byte offset calculation and token serialization.
-## Extends
-- [`Parser`](../../parser/classes/Parser.md)\<[`PdfToken`](../../tokens/token/classes/PdfToken.md), `number`\>
-## Constructors
-### Constructor
-> **new PdfTokenSerializer**(): `PdfTokenSerializer`
-#### Returns
-`PdfTokenSerializer`
-#### Inherited from
-[`Parser`](../../parser/classes/Parser.md).[`constructor`](../../parser/classes/Parser.md#constructor)
-## Properties
-### offset
-> **offset**: `number` = `0`
-Current byte offset in the output stream
-## Methods
-### calculateOffsets()
-> **calculateOffsets**(): `void`
-Pre-calculates byte offsets for all byte offset tokens in the buffer.
-Does not consume the buffer.
-#### Returns
-`void`
----
-### feed()
-> **feed**(...`input`): `void`
-Feeds tokens into the serializer buffer.
-#### Parameters
-##### input
-...[`PdfToken`](../../tokens/token/classes/PdfToken.md)[]
-PDF tokens to serialize
-#### Returns
-`void`
-#### Overrides
-[`Parser`](../../parser/classes/Parser.md).[`feed`](../../parser/classes/Parser.md#feed)
----
-### nextItems()
-> **nextItems**(): `Generator`\<`number`\>
-Generates bytes from the buffered tokens.
-Updates byte offset tokens as they are encountered.
-#### Returns
-`Generator`\<`number`\>
-A generator yielding individual bytes
-#### Overrides
-[`Parser`](../../parser/classes/Parser.md).[`nextItems`](../../parser/classes/Parser.md#nextitems)
----
-### toBytes()
-> **toBytes**(): [`ByteArray`](../../../types/type-aliases/ByteArray.md)
-Serializes all buffered tokens to a byte array.
-#### Returns
-[`ByteArray`](../../../types/type-aliases/ByteArray.md)
-The serialized PDF as a Uint8Array

package/docs/core/streams/object-stream/README.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**pdf-lite**](../../../README.md)
----
-[pdf-lite](../../../README.md) / core/streams/object-stream
-# core/streams/object-stream
-## Classes
-- [PdfObjectStream](classes/PdfObjectStream.md)