Daynight NPM | npm.io

🌞 Day or Night 🌚

Overview

"Day or Night" is a lightweight JavaScript utility designed to determine whether it is currently day or night in the user's location. Remarkably, this script accomplishes its task without requesting the user's location, relying on IP addresses, or utilizing advanced web features like DeviceLightEvent or light-level CSS media queries.

How It Works

The script operates by first acquiring the user's timezone name. It then calculates the geographical coordinates of the center of this timezone. Using these coordinates, "Day or Night" determines the local sunrise and sunset times to assess whether it is day or night.

The results are generally accurate. For a practical demonstration, visit our live demo.

Browser Compatibility

"Day or Night" relies on the Internationalization API for timezone detection. For browser compatibility details, please refer to Can I Use.

Installation

Install "Day or Night" using npm with the following command:

npm install daynight --save

Usage

Basic usage involves importing the daynight function and calling it to determine if it's light or dark:

import daynight from 'daynight'

const isLight = daynight().light

Advanced Usage

You can customize the function by passing a specific timezone and/or date:

daynight({
  timeZone: 'Africa/Nairobi',
  date: new Date('2012-12-20T12:00'),
})

Limitations

The script will not function correctly under the following conditions:

The browser lacks support for the Internationalization API.
The specified timezone is not recognized in the timezone list.

Output Structure

The function returns an object with the following structure:

{
  coordinates: [number, number],
  dark: boolean,
  light: boolean,
  sunrise: Date,
  sunset: Date,
  timezone: string,
  brightness: number,
  theme: 'day' | 'night'
}