API: Add types for parameters of gym-university-bladeburner API (#1591)

This commit is contained in:
catloversg
2024-08-17 03:29:24 +07:00
committed by GitHub
parent 289f60d8c8
commit da8870ed79
65 changed files with 1044 additions and 468 deletions

View File

@@ -9,7 +9,11 @@ Set a sleeve to take a class at a university.
**Signature:**
```typescript
setToUniversityCourse(sleeveNumber: number, university: string, className: string): boolean;
setToUniversityCourse(
sleeveNumber: number,
universityName: UniversityLocationName | `${UniversityLocationName}`,
courseName: UniversityClassType | `${UniversityClassType}`,
): boolean;
```
## Parameters
@@ -17,8 +21,8 @@ setToUniversityCourse(sleeveNumber: number, university: string, className: strin
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to start taking class. |
| university | string | Name of the university to attend. |
| className | string | Name of the class to follow. |
| universityName | [UniversityLocationName](./bitburner.universitylocationname.md) \| \`${[UniversityLocationName](./bitburner.universitylocationname.md)<!-- -->}\` | Name of the university to attend. |
| courseName | [UniversityClassType](./bitburner.universityclasstype.md) \| \`${[UniversityClassType](./bitburner.universityclasstype.md)<!-- -->}\` | Name of the course to follow. |
**Returns:**