Skip to content

Commit a08b51e

Browse files
committed
VERSION docs
1 parent a3c6bbb commit a08b51e

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ You can round floats down to any number of digits, and perform accurate math ope
3232

3333
To add Float Toolkit to your Node.js project, run this command:
3434

35-
```sh-session
35+
```bash
3636
npm install @float-toolkit/core
3737
```
3838

src/index.ts

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,13 +232,34 @@ namespace FloatToolkit {
232232
*/
233233
export type FirstNumberExtractedArray = [number | undefined, number[]];
234234

235-
interface Version {
235+
/**
236+
* An object containing the package version.
237+
*/
238+
export interface Version {
239+
/**
240+
* The full version number (M.m.P)
241+
*/
236242
get full(): string;
243+
244+
/**
245+
* The major version (first number)
246+
*/
237247
get major(): string;
248+
249+
/**
250+
* The minor version (second number)
251+
*/
238252
get minor(): string;
253+
254+
/**
255+
* The patch version (third number)
256+
*/
239257
get patch(): string;
240258
}
241259

260+
/**
261+
* Contains the package's major, minor and patch version numbers.
262+
*/
242263
export const VERSION: Version = {
243264
get full() {
244265
return PackageJSON.version;

0 commit comments

Comments
 (0)