Skip to content

Commit 746dff9

Browse files
benrr101benrr101
committed
Generate docs
1 parent de3407c commit 746dff9

File tree

91 files changed

+465
-585
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+465
-585
lines changed

‎docs/classes/AacFile.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ ___
152152

153153
• `get` **isPossiblyCorrupt**(): `boolean`
154154

155-
Indicates whether or not this file may be corrupt. Files with unknown corruptions should not
155+
Indicates whether this file may be corrupt. Files with unknown corruptions should not
156156
be written.
157157

158158
#### Returns
@@ -169,7 +169,7 @@ ___
169169

170170
• `get` **isWritable**(): `boolean`
171171

172-
Indicates whether or not tags can be written back to the current file.
172+
Indicates whether tags can be written back to the current file.
173173

174174
#### Returns
175175

@@ -518,7 +518,7 @@ Error Thrown when: 1) data is falsey, 2) start is not a safe, positive number, o
518518
| :------ | :------ | :------ | :------ |
519519
| `data` | [`ByteVector`](ByteVector.md) | `undefined` | Data to insert into the file. |
520520
| `start` | `number` | `undefined` | Index into the file at which to insert the data. Must be safe positive integer. |
521-
| `replace` | `number` | `0` | Number of bytes to replace. Typically this is the original size of the data block so that a new block will replace the old one. |
521+
| `replace` | `number` | `0` | Number of bytes to replace. Typically, this is the original size of the data block so that a new block will replace the old one. |
522522

523523
#### Returns
524524

‎docs/classes/AacFileSettings.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ ___
7070

7171
• `Static` `get` **preferApeTagAtFileEnd**(): `boolean`
7272

73-
Gets whether or not *new* APE tags should be stored at the end of the file. If `true` new
73+
Gets whether *new* APE tags should be stored at the end of the file. If `true` new
7474
APE tags will be stored at the end of the file. If `false` new APE tags will be stored at
7575
the beginning of the file (not recommended). Note, this only affects *new* APE tags.
7676
Existing APE tags will not be moved unless removed and re-added.
@@ -85,7 +85,7 @@ Existing APE tags will not be moved unless removed and re-added.
8585

8686
• `Static` `set` **preferApeTagAtFileEnd**(`value`): `void`
8787

88-
Gets whether or not *new* APE tags should be stored at the end of the file. If `true` new
88+
Gets whether *new* APE tags should be stored at the end of the file. If `true` new
8989
APE tags will be stored at the end of the file. If `false` new APE tags will be stored at
9090
the beginning of the file (not recommended). Note, this only affects *new* APE tags.
9191
Existing APE tags will not be moved unless removed and re-added.
@@ -110,7 +110,7 @@ ___
110110

111111
• `Static` `get` **preferId3v2TagAtFileEnd**(): `boolean`
112112

113-
Gets whether or not *new* ID3v2 tags should be stored at the end of the file. If `true` new
113+
Gets whether *new* ID3v2 tags should be stored at the end of the file. If `true` new
114114
ID3v2 tags will be stored at the end of the file. If `false` new ID3v2 tags will be stored
115115
at the beginning of the file. Note, this only affects *new* ID3v2 tags. Existing ID3v2 tags
116116
will not be moved unless removed and re-added.
@@ -131,7 +131,7 @@ In order to store an ID3v2 tag at the end of a file, it must have a tag footer.
131131

132132
• `Static` `set` **preferId3v2TagAtFileEnd**(`value`): `void`
133133

134-
Sets whether or not *new* ID3v2 tags should be stored at the end of the file. If `true` new
134+
Sets whether *new* ID3v2 tags should be stored at the end of the file. If `true` new
135135
ID3v2 tags will be stored at the end of the file. If `false` new ID3v2 tags will be stored
136136
at the beginning of the file. Note, this only affects *new* ID3v2 tags. Existing ID3v2 tags
137137
will not be moved unless removed and re-added.

‎docs/classes/AiffFile.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ ___
181181

182182
• `get` **isPossiblyCorrupt**(): `boolean`
183183

184-
Indicates whether or not this file may be corrupt. Files with unknown corruptions should not
184+
Indicates whether this file may be corrupt. Files with unknown corruptions should not
185185
be written.
186186

187187
#### Returns
@@ -198,7 +198,7 @@ ___
198198

199199
• `get` **isWritable**(): `boolean`
200200

201-
Indicates whether or not tags can be written back to the current file.
201+
Indicates whether tags can be written back to the current file.
202202

203203
#### Returns
204204

@@ -499,7 +499,7 @@ Error Thrown when: 1) data is falsey, 2) start is not a safe, positive number, o
499499
| :------ | :------ | :------ | :------ |
500500
| `data` | [`ByteVector`](ByteVector.md) | `undefined` | Data to insert into the file. |
501501
| `start` | `number` | `undefined` | Index into the file at which to insert the data. Must be safe positive integer. |
502-
| `replace` | `number` | `0` | Number of bytes to replace. Typically this is the original size of the data block so that a new block will replace the old one. |
502+
| `replace` | `number` | `0` | Number of bytes to replace. Typically, this is the original size of the data block so that a new block will replace the old one. |
503503

504504
#### Returns
505505

‎docs/classes/ApeFile.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ ___
155155

156156
• `get` **isPossiblyCorrupt**(): `boolean`
157157

158-
Indicates whether or not this file may be corrupt. Files with unknown corruptions should not
158+
Indicates whether this file may be corrupt. Files with unknown corruptions should not
159159
be written.
160160

161161
#### Returns
@@ -172,7 +172,7 @@ ___
172172

173173
• `get` **isWritable**(): `boolean`
174174

175-
Indicates whether or not tags can be written back to the current file.
175+
Indicates whether tags can be written back to the current file.
176176

177177
#### Returns
178178

@@ -521,7 +521,7 @@ Error Thrown when: 1) data is falsey, 2) start is not a safe, positive number, o
521521
| :------ | :------ | :------ | :------ |
522522
| `data` | [`ByteVector`](ByteVector.md) | `undefined` | Data to insert into the file. |
523523
| `start` | `number` | `undefined` | Index into the file at which to insert the data. Must be safe positive integer. |
524-
| `replace` | `number` | `0` | Number of bytes to replace. Typically this is the original size of the data block so that a new block will replace the old one. |
524+
| `replace` | `number` | `0` | Number of bytes to replace. Typically, this is the original size of the data block so that a new block will replace the old one. |
525525

526526
#### Returns
527527

‎docs/classes/ApeFileSettings.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ ___
7070

7171
• `Static` `get` **preferApeTagAtFileEnd**(): `boolean`
7272

73-
Gets whether or not *new* APE tags should be stored at the end of the file. If `true` new
73+
Gets whether *new* APE tags should be stored at the end of the file. If `true` new
7474
APE tags will be stored at the end of the file. If `false` new APE tags will be stored at
7575
the beginning of the file (not recommended). Note, this only affects *new* APE tags.
7676
Existing APE tags will not be moved unless removed and re-added.
@@ -85,7 +85,7 @@ Existing APE tags will not be moved unless removed and re-added.
8585

8686
• `Static` `set` **preferApeTagAtFileEnd**(`value`): `void`
8787

88-
Gets whether or not *new* APE tags should be stored at the end of the file. If `true` new
88+
Gets whether *new* APE tags should be stored at the end of the file. If `true` new
8989
APE tags will be stored at the end of the file. If `false` new APE tags will be stored at
9090
the beginning of the file (not recommended). Note, this only affects *new* APE tags.
9191
Existing APE tags will not be moved unless removed and re-added.
@@ -110,7 +110,7 @@ ___
110110

111111
• `Static` `get` **preferId3v2TagAtFileEnd**(): `boolean`
112112

113-
Gets whether or not *new* ID3v2 tags should be stored at the end of the file. If `true` new
113+
Gets whether *new* ID3v2 tags should be stored at the end of the file. If `true` new
114114
ID3v2 tags will be stored at the end of the file. If `false` new ID3v2 tags will be stored
115115
at the beginning of the file. Note, this only affects *new* ID3v2 tags. Existing ID3v2 tags
116116
will not be moved unless removed and re-added.
@@ -131,7 +131,7 @@ In order to store an ID3v2 tag at the end of a file, it must have a tag footer.
131131

132132
• `Static` `set` **preferId3v2TagAtFileEnd**(`value`): `void`
133133

134-
Sets whether or not *new* ID3v2 tags should be stored at the end of the file. If `true` new
134+
Sets whether *new* ID3v2 tags should be stored at the end of the file. If `true` new
135135
ID3v2 tags will be stored at the end of the file. If `false` new ID3v2 tags will be stored
136136
at the beginning of the file. Note, this only affects *new* ID3v2 tags. Existing ID3v2 tags
137137
will not be moved unless removed and re-added.

‎docs/classes/ApeTag.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ Tag.albumArtists
193193

194194
• `set` **albumArtists**(`value`): `void`
195195

196-
Sets the bands or artists who is credited in the creation of the entire album or
196+
Sets the bands or artists who are credited in the creation of the entire album or
197197
collection containing the media described by the current instance.
198198

199199
This field is typically optional but aids in the sorting of compilations or albums
@@ -441,7 +441,7 @@ Gets a user comment on the media represented by the current instance.
441441

442442
This field should be used to store user notes and comments. There is no constraint on
443443
what text can be stored here, but it should not contain programmatic data.
444-
Because this field contains notes the the user might think of while consuming the media,
444+
Because this field contains notes the user might think of while consuming the media,
445445
it may be useful for an application to make this field easily accessible, perhaps even
446446
including it in the main interface.
447447

@@ -463,7 +463,7 @@ Sets a user comment on the media represented by the current instance.
463463

464464
This field should be used to store user notes and comments. There is no constraint on
465465
what text can be stored here, but it should not contain programmatic data.
466-
Because this field contains notes the the user might think of while consuming the media,
466+
Because this field contains notes the user might think of while consuming the media,
467467
it may be useful for an application to make this field easily accessible, perhaps even
468468
including it in the main interface.
469469

@@ -1135,7 +1135,7 @@ ___
11351135

11361136
• `get` **isCompilation**(): `boolean`
11371137

1138-
Gets whether or not the album described by the current instance is a compilation.
1138+
Gets whether the album described by the current instance is a compilation.
11391139

11401140
#### Returns
11411141

@@ -1147,13 +1147,13 @@ Tag.isCompilation
11471147

11481148
• `set` **isCompilation**(`value`): `void`
11491149

1150-
Gets whether or not the album described by the current instance is a compilation.
1150+
Gets whether the album described by the current instance is a compilation.
11511151

11521152
#### Parameters
11531153

11541154
| Name | Type | Description |
11551155
| :------ | :------ | :------ |
1156-
| `value` | `boolean` | Whether or not the album described by the current instance is a compilation |
1156+
| `value` | `boolean` | Whether the album described by the current instance is a compilation |
11571157

11581158
#### Returns
11591159

@@ -1169,7 +1169,7 @@ ___
11691169

11701170
• `get` **isEmpty**(): `boolean`
11711171

1172-
Gets whether or not the current instance is empty.
1172+
Gets whether the current instance is empty.
11731173

11741174
#### Returns
11751175

@@ -1185,15 +1185,15 @@ ___
11851185

11861186
• `get` **isHeaderPresent**(): `boolean`
11871187

1188-
Gets whether or not the current instance has a header when rendered.
1188+
Gets whether the current instance has a header when rendered.
11891189

11901190
#### Returns
11911191

11921192
`boolean`
11931193

11941194
• `set` **isHeaderPresent**(`value`): `void`
11951195

1196-
Sets whether or not the current instance has a header when rendered.
1196+
Sets whether the current instance has a header when rendered.
11971197

11981198
#### Parameters
11991199

@@ -1922,7 +1922,7 @@ be simple in the form of "Above & Beyond" or more complicated in the form of
19221922
"Jono Grant, Tony McGuinness, Paavo Siljamäki", depending on the preferences of the
19231923
user and the degree to which they organize their media collection.
19241924
As the preference of the user may vary, applications should avoid limiting the user in
1925-
what constitutes the performers field - especially with regards to number of performers.
1925+
what constitutes the performers field - especially regarding the number of performers.
19261926

19271927
**`Remarks`**
19281928

‎docs/classes/ApeTagItem.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Class that represents a property in an APE tag.
3131

3232
• `get` **isEmpty**(): `boolean`
3333

34-
Gets whether or not the current instance is empty.
34+
Gets whether the current instance is empty.
3535

3636
#### Returns
3737

@@ -43,7 +43,7 @@ ___
4343

4444
• `get` **isReadOnly**(): `boolean`
4545

46-
Gets whether or not the current instance is flagged as read-only on disk.
46+
Gets whether the current instance is flagged as read-only on disk.
4747

4848
#### Returns
4949

‎docs/classes/AsfContentDescriptionObject.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -141,13 +141,13 @@ ___
141141

142142
• `get` **isEmpty**(): `boolean`
143143

144-
Gets whether or not the current instance is empty.
144+
Gets whether the current instance is empty.
145145

146146
#### Returns
147147

148148
`boolean`
149149

150-
`true` if all the values are cleared. Otherwise `false` is returned.
150+
`true` if all the values are cleared. Otherwise, `false` is returned.
151151

152152
___
153153

‎docs/classes/AsfExtendedContentDescriptionObject.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ ___
6868

6969
• `get` **isEmpty**(): `boolean`
7070

71-
Gets whether or not the current instance contains any records.
71+
Gets whether the current instance contains any records.
7272

7373
#### Returns
7474

‎docs/classes/AsfFile.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ ___
129129

130130
• `get` **isPossiblyCorrupt**(): `boolean`
131131

132-
Indicates whether or not this file may be corrupt. Files with unknown corruptions should not
132+
Indicates whether this file may be corrupt. Files with unknown corruptions should not
133133
be written.
134134

135135
#### Returns
@@ -146,7 +146,7 @@ ___
146146

147147
• `get` **isWritable**(): `boolean`
148148

149-
Indicates whether or not tags can be written back to the current file.
149+
Indicates whether tags can be written back to the current file.
150150

151151
#### Returns
152152

@@ -446,7 +446,7 @@ Error Thrown when: 1) data is falsey, 2) start is not a safe, positive number, o
446446
| :------ | :------ | :------ | :------ |
447447
| `data` | [`ByteVector`](ByteVector.md) | `undefined` | Data to insert into the file. |
448448
| `start` | `number` | `undefined` | Index into the file at which to insert the data. Must be safe positive integer. |
449-
| `replace` | `number` | `0` | Number of bytes to replace. Typically this is the original size of the data block so that a new block will replace the old one. |
449+
| `replace` | `number` | `0` | Number of bytes to replace. Typically, this is the original size of the data block so that a new block will replace the old one. |
450450

451451
#### Returns
452452

‎docs/classes/AsfHeaderObject.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ ___
9090

9191
• `get` **hasContentDescriptors**(): `boolean`
9292

93-
Gets whether or not the current instance contains either type of content descriptors.
93+
Gets whether the current instance contains either type of content descriptors.
9494

9595
#### Returns
9696

‎docs/classes/AsfMetadataLibraryObject.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ ___
5656

5757
• `get` **isEmpty**(): `boolean`
5858

59-
Gets whether or not the current instance contains any records.
59+
Gets whether the current instance contains any records.
6060

6161
#### Returns
6262

0 commit comments

Comments
 (0)