pdf-lite 1.0.0 → 1.0.1-alpha.2

package/docs/core/objects/pdf-number/classes/PdfNumber.md

@@ -0,0 +1,345 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [core/objects/pdf-number](../README.md) / PdfNumber
+
+# Class: PdfNumber
+
+## Extends
+
+- [`PdfObject`](../../pdf-object/classes/PdfObject.md)
+
+## Extended by
+
+- [`PdfByteOffsetNumber`](PdfByteOffsetNumber.md)
+
+## Constructors
+
+### Constructor
+
+> **new PdfNumber**(`options`): `PdfNumber`
+
+#### Parameters
+
+##### options
+
+`number` | [`Ref`](../../../ref/classes/Ref.md)\<`number`\> | `PdfNumber` | \{ `decimalPlaces?`: `number`; `padTo?`: `number`; `value`: `number` \| [`Ref`](../../../ref/classes/Ref.md)\<`number`\>; \}
+
+#### Returns
+
+`PdfNumber`
+
+#### Overrides
+
+[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`constructor`](../../pdf-object/classes/PdfObject.md#constructor)
+
+## Properties
+
+### decimalPlaces
+
+> **decimalPlaces**: `number`
+
+---
+
+### isByteOffset
+
+> **isByteOffset**: `boolean` = `false`
+
+---
+
+### 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)
+
+---
+
+### padTo
+
+> **padTo**: `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)
+
+## 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)
+
+---
+
+### ref
+
+#### Get Signature
+
+> **get** **ref**(): [`Ref`](../../../ref/classes/Ref.md)\<`number`\>
+
+##### Returns
+
+[`Ref`](../../../ref/classes/Ref.md)\<`number`\>
+
+---
+
+### value
+
+#### Get Signature
+
+> **get** **value**(): `number`
+
+##### Returns
+
+`number`
+
+#### Set Signature
+
+> **set** **value**(`value`): `void`
+
+##### Parameters
+
+###### value
+
+`number`
+
+##### Returns
+
+`void`
+
+## 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)
+
+---
+
+### onChange()
+
+> **onChange**(`callback`): `void`
+
+#### Parameters
+
+##### callback
+
+(`value`) => `void`
+
+#### Returns
+
+`void`
+
+---
+
+### 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**(): [`PdfNumberToken`](../../../tokens/number-token/classes/PdfNumberToken.md)[]
+
+Tokenizes the object into an array of PdfTokens
+
+#### Returns
+
+[`PdfNumberToken`](../../../tokens/number-token/classes/PdfNumberToken.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)
+
+---
+
+### toToken()
+
+> **toToken**(): [`PdfNumberToken`](../../../tokens/number-token/classes/PdfNumberToken.md)
+
+#### Returns
+
+[`PdfNumberToken`](../../../tokens/number-token/classes/PdfNumberToken.md)
+
+---
+
+### 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-object/README.md

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

package/docs/core/objects/pdf-object/classes/PdfObject.md

@@ -0,0 +1,214 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [core/objects/pdf-object](../README.md) / PdfObject
+
+# Abstract Class: PdfObject
+
+## Extended by
+
+- [`PdfDocument`](../../../../pdf/pdf-document/classes/PdfDocument.md)
+- [`PdfRevision`](../../../../pdf/pdf-revision/classes/PdfRevision.md)
+- [`PdfArray`](../../pdf-array/classes/PdfArray.md)
+- [`PdfBoolean`](../../pdf-boolean/classes/PdfBoolean.md)
+- [`PdfComment`](../../pdf-comment/classes/PdfComment.md)
+- [`PdfDictionary`](../../pdf-dictionary/classes/PdfDictionary.md)
+- [`PdfHexadecimal`](../../pdf-hexadecimal/classes/PdfHexadecimal.md)
+- [`PdfName`](../../pdf-name/classes/PdfName.md)
+- [`PdfNull`](../../pdf-null/classes/PdfNull.md)
+- [`PdfNumber`](../../pdf-number/classes/PdfNumber.md)
+- [`PdfObjectReference`](../../pdf-object-reference/classes/PdfObjectReference.md)
+- [`PdfStartXRef`](../../pdf-start-xref/classes/PdfStartXRef.md)
+- [`PdfStream`](../../pdf-stream/classes/PdfStream.md)
+- [`PdfString`](../../pdf-string/classes/PdfString.md)
+- [`PdfTrailer`](../../pdf-trailer/classes/PdfTrailer.md)
+- [`PdfXRefTableEntry`](../../pdf-xref-table/classes/PdfXRefTableEntry.md)
+- [`PdfXRefTableSectionHeader`](../../pdf-xref-table/classes/PdfXRefTableSectionHeader.md)
+- [`PdfXRefTable`](../../pdf-xref-table/classes/PdfXRefTable.md)
+
+## Constructors
+
+### Constructor
+
+> **new PdfObject**(): `PdfObject`
+
+#### Returns
+
+`PdfObject`
+
+## Properties
+
+### 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
+
+---
+
+### postTokens?
+
+> `optional` **postTokens**: [`PdfToken`](../../../tokens/token/classes/PdfToken.md)[]
+
+Optional tokens to prepend or append during serialization
+
+---
+
+### preTokens?
+
+> `optional` **preTokens**: [`PdfToken`](../../../tokens/token/classes/PdfToken.md)[]
+
+Optional tokens to prepend or append during serialization
+
+## Accessors
+
+### objectType
+
+#### Get Signature
+
+> **get** **objectType**(): `string`
+
+The type of this PDF object
+
+##### Returns
+
+`string`
+
+## Methods
+
+### as()
+
+> **as**\<`T`\>(`ctor`): `T`
+
+Attempts to cast the object to a specific PdfObject subclass
+
+#### Type Parameters
+
+##### T
+
+`T` _extends_ `PdfObject`
+
+#### Parameters
+
+##### ctor
+
+(...`args`) => `T`
+
+#### Returns
+
+`T`
+
+---
+
+### clone()
+
+> `abstract` **clone**(): `this`
+
+Creates a deep clone of the object
+
+#### Returns
+
+`this`
+
+---
+
+### equals()
+
+> **equals**(`other?`): `boolean`
+
+Compares this object to another for equality based on their token representations
+
+#### Parameters
+
+##### other?
+
+`PdfObject`
+
+#### Returns
+
+`boolean`
+
+---
+
+### isModified()
+
+> **isModified**(): `boolean`
+
+Indicates whether the object has been modified. Override this method if the modified state is determined differently
+
+#### Returns
+
+`boolean`
+
+---
+
+### 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`
+
+---
+
+### 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)
+
+---
+
+### tokenize()
+
+> `abstract` `protected` **tokenize**(): [`PdfToken`](../../../tokens/token/classes/PdfToken.md)[]
+
+Tokenizes the object into an array of PdfTokens
+
+#### Returns
+
+[`PdfToken`](../../../tokens/token/classes/PdfToken.md)[]
+
+---
+
+### toString()
+
+> **toString**(): `string`
+
+Converts the object to a string representation
+
+#### Returns
+
+`string`
+
+---
+
+### 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)[]

package/docs/core/objects/pdf-object-reference/README.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / core/objects/pdf-object-reference
+
+# core/objects/pdf-object-reference
+
+## Classes
+
+- [PdfObjectReference](classes/PdfObjectReference.md)