Skip to content

Tiny utility to determine if a user is in the U.S., without an HTTP request or IP address

License

Notifications You must be signed in to change notification settings

usermirror/in-us

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌎 in-us

Utility to determine if a user is in the United States
without an HTTP request or IP address.


It uses the browser's timezone (via jstz and locale (navigator.languages) to infer whether someone is in United States. This project is inspired by in-eu by Segment.

Getting Started

Installation

Install with npm:

npm install --save in-us

Or with yarn:

yarn add in-us

Usage

inUS

import inUS from 'in-us'

inUS()
// => true | false

isInUSTimezone

import { isInUSTimezone } from 'in-us'

/*
  Only checks the browser timezone.
  e.g. America/Chicago
*/

isInUSTimezone()
// => true | false

isUSLocale

import { isUSLocale } from 'in-us'

/*
  Only uses the browser's language/locale
  e.g. es-US (spanish from United Staes)
*/

isUSLocale()
// => true | false

Contributing

All contributions are super welcome! in-us is MIT-licensed.

About

Tiny utility to determine if a user is in the U.S., without an HTTP request or IP address

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published