pdf-lite 1.0.0 → 1.0.1-alpha.2

package/docs/core/objects/pdf-comment/classes/PdfComment.md

@@ -0,0 +1,329 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [core/objects/pdf-comment](../README.md) / PdfComment
+
+# Class: PdfComment
+
+## Extends
+
+- [`PdfObject`](../../pdf-object/classes/PdfObject.md)
+
+## Constructors
+
+### Constructor
+
+> **new PdfComment**(`raw`): `PdfComment`
+
+#### Parameters
+
+##### raw
+
+`string` | [`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+#### Returns
+
+`PdfComment`
+
+#### Overrides
+
+[`PdfObject`](../../pdf-object/classes/PdfObject.md).[`constructor`](../../pdf-object/classes/PdfObject.md#constructor)
+
+## 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
+
+#### 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)
+
+---
+
+### raw
+
+> **raw**: [`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+The comment value as raw bytes.
+
+---
+
+### EOF
+
+> `static` **EOF**: `PdfComment`
+
+## 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)
+
+---
+
+### asString()
+
+> **asString**(): `string`
+
+#### Returns
+
+`string`
+
+---
+
+### 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)
+
+---
+
+### isEof()
+
+> **isEof**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+---
+
+### isEOFComment()
+
+> **isEOFComment**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+---
+
+### 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)
+
+---
+
+### isVersionComment()
+
+> **isVersionComment**(): `boolean`
+
+#### 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`
+
+#### 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**(): [`PdfCommentToken`](../../../tokens/comment-token/classes/PdfCommentToken.md)[]
+
+Tokenizes the object into an array of PdfTokens
+
+#### Returns
+
+[`PdfCommentToken`](../../../tokens/comment-token/classes/PdfCommentToken.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)
+
+---
+
+### versionComment()
+
+> `static` **versionComment**(`version`): `PdfComment`
+
+#### Parameters
+
+##### version
+
+`string`
+
+#### Returns
+
+`PdfComment`

package/docs/core/objects/pdf-date/README.md

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

package/docs/core/objects/pdf-date/classes/PdfDate.md

@@ -0,0 +1,317 @@
+[**pdf-lite**](../../../../README.md)
+
+---
+
+[pdf-lite](../../../../README.md) / [core/objects/pdf-date](../README.md) / PdfDate
+
+# Class: PdfDate
+
+## Extends
+
+- [`PdfString`](../../pdf-string/classes/PdfString.md)
+
+## Constructors
+
+### Constructor
+
+> **new PdfDate**(`date`): `PdfDate`
+
+#### Parameters
+
+##### date
+
+`Date`
+
+#### Returns
+
+`PdfDate`
+
+#### Overrides
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`constructor`](../../pdf-string/classes/PdfString.md#constructor)
+
+## 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
+
+#### Inherited from
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`modified`](../../pdf-string/classes/PdfString.md#modified)
+
+---
+
+### postTokens?
+
+> `optional` **postTokens**: [`PdfToken`](../../../tokens/token/classes/PdfToken.md)[]
+
+Optional tokens to prepend or append during serialization
+
+#### Inherited from
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`postTokens`](../../pdf-string/classes/PdfString.md#posttokens)
+
+---
+
+### preTokens?
+
+> `optional` **preTokens**: [`PdfToken`](../../../tokens/token/classes/PdfToken.md)[]
+
+Optional tokens to prepend or append during serialization
+
+#### Inherited from
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`preTokens`](../../pdf-string/classes/PdfString.md#pretokens)
+
+## Accessors
+
+### date
+
+#### Get Signature
+
+> **get** **date**(): `Date`
+
+##### Returns
+
+`Date`
+
+---
+
+### objectType
+
+#### Get Signature
+
+> **get** **objectType**(): `string`
+
+The type of this PDF object
+
+##### Returns
+
+`string`
+
+#### Inherited from
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`objectType`](../../pdf-string/classes/PdfString.md#objecttype)
+
+---
+
+### raw
+
+#### Get Signature
+
+> **get** **raw**(): [`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+##### Returns
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+#### Set Signature
+
+> **set** **raw**(`raw`): `void`
+
+##### Parameters
+
+###### raw
+
+[`ByteArray`](../../../../types/type-aliases/ByteArray.md)
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`raw`](../../pdf-string/classes/PdfString.md#raw)
+
+---
+
+### value
+
+#### Get Signature
+
+> **get** **value**(): `string`
+
+##### Returns
+
+`string`
+
+#### Inherited from
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`value`](../../pdf-string/classes/PdfString.md#value)
+
+## 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
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`as`](../../pdf-string/classes/PdfString.md#as)
+
+---
+
+### clone()
+
+> **clone**(): `this`
+
+Creates a deep clone of the object
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`clone`](../../pdf-string/classes/PdfString.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
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`equals`](../../pdf-string/classes/PdfString.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
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`isModified`](../../pdf-string/classes/PdfString.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
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`setModified`](../../pdf-string/classes/PdfString.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
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`toBytes`](../../pdf-string/classes/PdfString.md#tobytes)
+
+---
+
+### tokenize()
+
+> `protected` **tokenize**(): [`PdfStringToken`](../../../tokens/string-token/classes/PdfStringToken.md)[]
+
+Tokenizes the object into an array of PdfTokens
+
+#### Returns
+
+[`PdfStringToken`](../../../tokens/string-token/classes/PdfStringToken.md)[]
+
+#### Inherited from
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`tokenize`](../../pdf-string/classes/PdfString.md#tokenize)
+
+---
+
+### toString()
+
+> **toString**(): `string`
+
+Converts the object to a string representation
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`toString`](../../pdf-string/classes/PdfString.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
+
+[`PdfString`](../../pdf-string/classes/PdfString.md).[`toTokens`](../../pdf-string/classes/PdfString.md#totokens)

package/docs/core/objects/pdf-dictionary/README.md

@@ -0,0 +1,17 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / core/objects/pdf-dictionary
+
+# core/objects/pdf-dictionary
+
+## Classes
+
+- [PdfDictionary](classes/PdfDictionary.md)
+
+## Type Aliases
+
+- [PdfDictionaryEntries](type-aliases/PdfDictionaryEntries.md)
+- [PdfDictionaryEntry](type-aliases/PdfDictionaryEntry.md)
+- [PdfDictionaryMap](type-aliases/PdfDictionaryMap.md)