GalacticFactory/PackwizJS
Archived
4
1
Fork 0
Code Issues 2 Pull requests 4 Projects Wiki Activity Actions

fix Packwiz class docs

Browse source
This commit is contained in:
cswimr 2025-02-09 10:36:20 -06:00
parent 5115c9ac55
commit 34dd638291
Signed by: cswimr
GPG key ID: 0EC431A8DA8F8087
3 changed files with 56 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

86
docs/parser/classes/Packwiz.md
View file

@ -6,49 +6,19 @@
# Class: Packwiz
Defined in: parser.ts:159
Defined in: parser.ts:151
A class representing a Packwiz TOML file.
## Param
The location of the TOML file.
## Param
The index of the TOML file.
## Param
The name of the pack.
## Param
The packwiz version of the TOML file.
## Param
The authors of the pack.
## Param
The description of the pack.
## Param
The version of the pack.
## Param
The Minecraft / modloader versions that the pack uses.
## Constructors
### new Packwiz()
> **new Packwiz**(`location`, `index`, `name`, `packFormat`, `authors`, `description`, `version`, `versions`): [`Packwiz`](Packwiz.md)
Defined in: parser.ts:160
Defined in: parser.ts:163
Creates a new Packwiz instance.
#### Parameters
@ -56,34 +26,50 @@ Defined in: parser.ts:160
[`Resource`](../../resource/classes/Resource.md)
The location of the TOML file.
##### index
[`PackwizIndex`](../interfaces/PackwizIndex.md)
The index of the TOML file.
##### name
`string`
The name of the pack.
##### packFormat
`string` = `"packwiz:1.0.0"`
The packwiz version of the TOML file.
##### authors
`string`[]
The authors of the pack.
##### description
`string`
The description of the pack.
##### version
`string`
The version of the pack.
##### versions
[`PackwizVersions`](../interfaces/PackwizVersions.md)
The Minecraft / modloader versions that the pack uses.
#### Returns
[`Packwiz`](Packwiz.md)
@ -94,7 +80,9 @@ Defined in: parser.ts:160
> `readonly` **authors**: `string`[]
Defined in: parser.ts:165
Defined in: parser.ts:168
The authors of the pack.
***
@ -102,7 +90,9 @@ Defined in: parser.ts:165
> `readonly` **description**: `string`
Defined in: parser.ts:166
Defined in: parser.ts:169
The description of the pack.
***
@ -110,7 +100,9 @@ Defined in: parser.ts:166
> `readonly` **index**: [`PackwizIndex`](../interfaces/PackwizIndex.md)
Defined in: parser.ts:162
Defined in: parser.ts:165
The index of the TOML file.
***
@ -118,7 +110,9 @@ Defined in: parser.ts:162
> `readonly` **location**: [`Resource`](../../resource/classes/Resource.md)
Defined in: parser.ts:161
Defined in: parser.ts:164
The location of the TOML file.
***
@ -126,7 +120,9 @@ Defined in: parser.ts:161
> `readonly` **name**: `string`
Defined in: parser.ts:163
Defined in: parser.ts:166
The name of the pack.
***
@ -134,7 +130,9 @@ Defined in: parser.ts:163
> `readonly` **packFormat**: `string` = `"packwiz:1.0.0"`
Defined in: parser.ts:164
Defined in: parser.ts:167
The packwiz version of the TOML file.
***
@ -142,7 +140,9 @@ Defined in: parser.ts:164
> `readonly` **version**: `string`
Defined in: parser.ts:167
Defined in: parser.ts:170
The version of the pack.
***
@ -150,4 +150,6 @@ Defined in: parser.ts:167
> `readonly` **versions**: [`PackwizVersions`](../interfaces/PackwizVersions.md)
Defined in: parser.ts:168
Defined in: parser.ts:171
The Minecraft / modloader versions that the pack uses.

2
docs/parser/functions/parsePackwiz.md
View file

@ -8,7 +8,7 @@
> **parsePackwiz**(`filePath`): `Promise`\<[`Packwiz`](../classes/Packwiz.md)\>
Defined in: parser.ts:190
Defined in: parser.ts:193
Parses a packwiz.toml file and returns its contents.