wishthis/node_modules/macos-release/index.d.ts
2022-01-21 09:28:41 +01:00

40 lines
1.2 KiB
TypeScript

declare const macosRelease: {
/**
Get the name and version of a macOS release from the Darwin version.
@param release - By default, the current operating system is used, but you can supply a custom [Darwin kernel version](https://en.wikipedia.org/wiki/Darwin_%28operating_system%29#Release_history), which is the output of [`os.release()`](https://nodejs.org/api/os.html#os_os_release).
@example
```
import * as os from 'os';
import macosRelease = require('macos-release');
// On a macOS Sierra system
macosRelease();
//=> {name: 'Sierra', version: '10.12'}
os.release();
//=> 13.2.0
// This is the Darwin kernel version
macosRelease(os.release());
//=> {name: 'Sierra', version: '10.12'}
macosRelease('14.0.0');
//=> {name: 'Yosemite', version: '10.10'}
macosRelease('20.0.0');
//=> {name: 'Big Sur', version: '11'}
```
*/
(): {name: string, version: string}
(release: string): {name: string, version: string} | undefined;
// TODO: remove this in the next major version, refactor the whole definition to:
// declare function macosRelease(release?: string): {name: string, version: string};
// export = macosRelease;
default: typeof macosRelease;
};
export = macosRelease;