PackwizJS/docs/parser/classes/Packwiz.md

154 lines
1.9 KiB
Markdown
Raw Normal View History

2025-02-09 10:00:02 -06:00
[**packwizjs**](../../README.md)
***
[packwizjs](../../modules.md) / [parser](../README.md) / Packwiz
# Class: Packwiz
2025-02-09 10:24:15 -06:00
Defined in: parser.ts:159
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.
2025-02-09 10:00:02 -06:00
## Constructors
### new Packwiz()
> **new Packwiz**(`location`, `index`, `name`, `packFormat`, `authors`, `description`, `version`, `versions`): [`Packwiz`](Packwiz.md)
2025-02-09 10:24:15 -06:00
Defined in: parser.ts:160
2025-02-09 10:00:02 -06:00
#### Parameters
##### location
[`Resource`](../../resource/classes/Resource.md)
##### index
[`PackwizIndex`](../interfaces/PackwizIndex.md)
##### name
`string`
##### packFormat
`string` = `"packwiz:1.0.0"`
##### authors
`string`[]
##### description
`string`
##### version
`string`
##### versions
[`PackwizVersions`](../interfaces/PackwizVersions.md)
#### Returns
[`Packwiz`](Packwiz.md)
## Properties
### authors
> `readonly` **authors**: `string`[]
2025-02-09 10:24:15 -06:00
Defined in: parser.ts:165
2025-02-09 10:00:02 -06:00
***
### description
> `readonly` **description**: `string`
2025-02-09 10:24:15 -06:00
Defined in: parser.ts:166
2025-02-09 10:00:02 -06:00
***
### index
> `readonly` **index**: [`PackwizIndex`](../interfaces/PackwizIndex.md)
2025-02-09 10:24:15 -06:00
Defined in: parser.ts:162
2025-02-09 10:00:02 -06:00
***
### location
> `readonly` **location**: [`Resource`](../../resource/classes/Resource.md)
2025-02-09 10:24:15 -06:00
Defined in: parser.ts:161
2025-02-09 10:00:02 -06:00
***
### name
> `readonly` **name**: `string`
2025-02-09 10:24:15 -06:00
Defined in: parser.ts:163
2025-02-09 10:00:02 -06:00
***
### packFormat
> `readonly` **packFormat**: `string` = `"packwiz:1.0.0"`
2025-02-09 10:24:15 -06:00
Defined in: parser.ts:164
2025-02-09 10:00:02 -06:00
***
### version
> `readonly` **version**: `string`
2025-02-09 10:24:15 -06:00
Defined in: parser.ts:167
2025-02-09 10:00:02 -06:00
***
### versions
> `readonly` **versions**: [`PackwizVersions`](../interfaces/PackwizVersions.md)
2025-02-09 10:24:15 -06:00
Defined in: parser.ts:168