pdf-lite 1.0.0 → 1.0.1-alpha.2

package/docs/core/objects/pdf-trailer/type-aliases/PdfTrailerEntries.md

@@ -0,0 +1,51 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [core/objects/pdf-trailer](../README.md) / PdfTrailerEntries
+
+# Type Alias: PdfTrailerEntries
+
+> **PdfTrailerEntries** = `object`
+
+## Properties
+
+### Encrypt?
+
+> `optional` **Encrypt**: [`PdfObjectReference`](../../pdf-object-reference/classes/PdfObjectReference.md)
+
+---
+
+### ID?
+
+> `optional` **ID**: [`PdfArray`](../../pdf-array/classes/PdfArray.md)\<[`PdfHexadecimal`](../../pdf-hexadecimal/classes/PdfHexadecimal.md)\>
+
+---
+
+### Info?
+
+> `optional` **Info**: [`PdfObjectReference`](../../pdf-object-reference/classes/PdfObjectReference.md)
+
+---
+
+### Prev?
+
+> `optional` **Prev**: [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)
+
+---
+
+### Root?
+
+> `optional` **Root**: [`PdfObjectReference`](../../pdf-object-reference/classes/PdfObjectReference.md)
+
+---
+
+### Size
+
+> **Size**: [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)
+
+---
+
+### XRefStm?
+
+> `optional` **XRefStm**: [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)

package/docs/core/objects/pdf-xref-table/README.md

@@ -0,0 +1,13 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / core/objects/pdf-xref-table
+
+# core/objects/pdf-xref-table
+
+## Classes
+
+- [PdfXRefTable](classes/PdfXRefTable.md)
+- [PdfXRefTableEntry](classes/PdfXRefTableEntry.md)
+- [PdfXRefTableSectionHeader](classes/PdfXRefTableSectionHeader.md)

package/docs/core/objects/pdf-xref-table/classes/PdfXRefTable.md

@@ -0,0 +1,331 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [core/objects/pdf-xref-table](../README.md) / PdfXRefTable
+
+# Class: PdfXRefTable
+
+## Extends
+
+- [`PdfObject`](../../pdf-object/classes/PdfObject.md)
+
+## Constructors
+
+### Constructor
+
+> **new PdfXRefTable**(`options?`): `PdfXRefTable`
+
+#### Parameters
+
+##### options?
+
+###### entries?
+
+[`PdfXRefTableEntry`](PdfXRefTableEntry.md)[]
+
+###### offset?
+
+`number` \| [`Ref`](../../../ref/classes/Ref.md)\<`number`\>
+
+###### sections?
+
+[`PdfXRefTableSectionHeader`](PdfXRefTableSectionHeader.md)[]
+
+#### Returns
+
+`PdfXRefTable`
+
+#### Overrides
+
+[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`constructor`](../../pdf-object/classes/PdfObject.md#constructor)
+
+## Properties
+
+### entries
+
+> **entries**: [`PdfXRefTableEntry`](PdfXRefTableEntry.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)
+
+---
+
+### offset
+
+> **offset**: [`Ref`](../../../ref/classes/Ref.md)\<`number`\>
+
+---
+
+### 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)
+
+---
+
+### sections
+
+> **sections**: [`PdfXRefTableSectionHeader`](PdfXRefTableSectionHeader.md)[]
+
+## Accessors
+
+### lastSection
+
+#### Get Signature
+
+> **get** **lastSection**(): [`PdfXRefTableSectionHeader`](PdfXRefTableSectionHeader.md) \| `null`
+
+##### Returns
+
+[`PdfXRefTableSectionHeader`](PdfXRefTableSectionHeader.md) \| `null`
+
+---
+
+### 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
+
+### addEntryForObject()
+
+> **addEntryForObject**(`obj`): `void`
+
+#### Parameters
+
+##### obj
+
+[`PdfIndirectObject`](../../pdf-indirect-object/classes/PdfIndirectObject.md)
+
+#### Returns
+
+`void`
+
+---
+
+### 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)
+
+---
+
+### getEntry()
+
+> **getEntry**(`objectNumber`): [`PdfXRefTableEntry`](PdfXRefTableEntry.md) \| `undefined`
+
+#### Parameters
+
+##### objectNumber
+
+`number`
+
+#### Returns
+
+[`PdfXRefTableEntry`](PdfXRefTableEntry.md) \| `undefined`
+
+---
+
+### isModified()
+
+> **isModified**(): `boolean`
+
+Indicates whether the object has been modified. Override this method if the modified state is determined differently
+
+#### Returns
+
+`boolean`
+
+#### Overrides
+
+[`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**(): [`PdfToken`](../../../tokens/token/classes/PdfToken.md)[]
+
+Tokenizes the object into an array of PdfTokens
+
+#### Returns
+
+[`PdfToken`](../../../tokens/token/classes/PdfToken.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/objects/pdf-xref-table/classes/PdfXRefTableEntry.md

@@ -0,0 +1,297 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [core/objects/pdf-xref-table](../README.md) / PdfXRefTableEntry
+
+# Class: PdfXRefTableEntry
+
+## Extends
+
+- [`PdfObject`](../../pdf-object/classes/PdfObject.md)
+
+## Constructors
+
+### Constructor
+
+> **new PdfXRefTableEntry**(`options`): `PdfXRefTableEntry`
+
+#### Parameters
+
+##### options
+
+###### byteOffset
+
+`number` \| [`Ref`](../../../ref/classes/Ref.md)\<`number`\> \| [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)
+
+###### generationNumber
+
+`number` \| [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)
+
+###### inUse
+
+`boolean`
+
+###### objectNumber
+
+`number` \| [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)
+
+#### Returns
+
+`PdfXRefTableEntry`
+
+#### Overrides
+
+[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`constructor`](../../pdf-object/classes/PdfObject.md#constructor)
+
+## Properties
+
+### byteOffset
+
+> **byteOffset**: [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)
+
+---
+
+### generationNumber
+
+> **generationNumber**: [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)
+
+---
+
+### inUse
+
+> **inUse**: `boolean`
+
+---
+
+### 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)
+
+---
+
+### objectNumber
+
+> **objectNumber**: [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)
+
+---
+
+### 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)
+
+## 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`
+
+#### Overrides
+
+[`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**(): [`PdfXRefTableEntryToken`](../../../tokens/xref-table-entry-token/classes/PdfXRefTableEntryToken.md)[]
+
+Tokenizes the object into an array of PdfTokens
+
+#### Returns
+
+[`PdfXRefTableEntryToken`](../../../tokens/xref-table-entry-token/classes/PdfXRefTableEntryToken.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)