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

improved some provider comments
All checks were successful
Actions / Build and Push Documentation (push) Successful in 16s
Details

Browse source
This commit is contained in:
cswimr 2025-02-10 05:27:52 -06:00
parent f5813826e4
commit 9b8f184ff1
Signed by: cswimr
GPG key ID: 0EC431A8DA8F8087
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/provider.ts
View file

@ -9,7 +9,7 @@ export class UrlProvider {
* Creates a new UrlProvider instance. * Creates a new UrlProvider instance.
* @param hash - A hash string used for identifying or verifying the resource. * @param hash - A hash string used for identifying or verifying the resource.
* @param hashFormat - The format of the provided hash. * @param hashFormat - The format of the provided hash.
* @param url - A Resource instance representing the URL. * @param url - A Resource instance representing the URL where the file can be downloaded from.
*/ */
constructor( constructor(
public hash: string, public hash: string,
@ -27,7 +27,7 @@ export class ModrinthProvider extends UrlProvider {
* Creates a new ModrinthProvider instance. * Creates a new ModrinthProvider instance.
* @param hash - A hash string used for identification or verification. * @param hash - A hash string used for identification or verification.
* @param hashFormat - The format of the provided hash. * @param hashFormat - The format of the provided hash.
* @param url - A Resource instance representing the URL. * @param url - A Resource instance representing the URL where the file can be downloaded from.
* @param modId - The identifier for the Modrinth mod. * @param modId - The identifier for the Modrinth mod.
* @param versionId - The version identifier for the mod. * @param versionId - The version identifier for the mod.
*/ */
@ -51,7 +51,7 @@ export class GitHubProvider extends UrlProvider {
* Creates a new GitHubProvider instance. * Creates a new GitHubProvider instance.
* @param hash - A hash string used for identification or verification. * @param hash - A hash string used for identification or verification.
* @param hashFormat - The format of the hash. * @param hashFormat - The format of the hash.
* @param url - A Resource instance representing the URL. * @param url - A Resource instance representing the URL where the file can be downloaded from.
* @param branch - The branch name within the GitHub repository. * @param branch - The branch name within the GitHub repository.
* @param regex - A regular expression for matching specific patterns in the GitHub URL. * @param regex - A regular expression for matching specific patterns in the GitHub URL.
* @param slug - A URL slug used for identifying the repository. * @param slug - A URL slug used for identifying the repository.