https://github.com/beyondkmp/check-24-hours-time
A thin wrapper native interface to check the system setting is the 24 hours time format
https://github.com/beyondkmp/check-24-hours-time
Last synced: about 1 year ago
JSON representation
A thin wrapper native interface to check the system setting is the 24 hours time format
- Host: GitHub
- URL: https://github.com/beyondkmp/check-24-hours-time
- Owner: beyondkmp
- License: mit
- Created: 2023-01-04T10:56:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-29T12:44:26.000Z (almost 3 years ago)
- Last Synced: 2025-04-13T00:09:22.698Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.35 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Check 24 hours time
A thin wrapper native interface to check the system setting is the 24 hours time
format
## Goals
- zero dependencies
- leverage TypeScript declarations wherever possible
## Install
```shellsession
$ yarn add check-24-hours-time
# or
$ npm install --save check-24-hours-time
```
## API
```typescript
import { is24hoursTimeFormat, getUserDefaultLocaleName } from 'check-24-hours-time'
// is24hoursTimeFormat returns true if system time is 24 hours. returns false if 12 hours
const result = is24hoursTimeFormat()
console.log(result)
// getUserDefaultLocaleName returns the user default locale name, return default(en-US) if there's an error
const result = getUserDefaultLocaleName()
console.log(result)
```
## Documentation
See the documentation under the
[`docs`](https://github.com/beyondkmp/check-24-hours-time/tree/master/docs)
folder.
## Supported versions
Each release includes prebuilt binaries based on
[N-API](https://nodejs.org/api/n-api.html), with support for different versions
of Node and Electron. Please refer to the
[N-API version matrix](https://nodejs.org/api/n-api.html#node-api-version-matrix)
and the release documentation for [Node](https://github.com/nodejs/Release) and
[Electron](https://electronjs.org/docs/tutorial/support) to see what is
supported currently.
## Contributing
Read the
[Setup](https://github.com/beyondkmp/check-24-hours-time/blob/master/docs/index.md#setup)
section to ensure your development environment is setup for what you need.
If you want to see something supported, open an issue to start a discussion
about it.