name-day-calendar
Module for providing lists of the official names in a calendar by specific country. Name by day with additional options (e.g.by sex). Contain names database, handlers, and types for TypeScript.
Install
npm install name-day-calendar
Supported Countries
If you are missing name days from your country please consider CONTRIBUTING.
Countries: 1
├── SK: Slovenská republika (467 names)
├── AT: Österreich (not yet)
├── CZ: Česká republika (not yet)
├── PL: Polska (not yet)
└── HU: Magyarország (not yet)
Usage
To avoid big bundle size. Data are split and loaded on usage. Data are separated into chunks by country, month, and sex.
example:
import { getNameOnDate } from 'name-day-calendar';
const name: string[] = await getNameOnDate(new Date(1988, 6, 29));
const name: string[] = await getNameOnDate('06-30', { lang: 'SK' });
const name: string[] = await getNameOnDate('06-30', { sex: 'male', lang: 'SK' });
API
getNameOnDate
getNameOnDate = async (date: string | Date, options?: SearchOptions)
SearchOptions
interface SearchOptions {
lang?: CountryCode | CountryCode[];
sex?: 'male' | 'female';
}
Contribution and License Agreement
You like to contribute please read CONTRIBUTING.md.
If you contribute code to this project, you are implicitly allowing your
code to be distributed under the MIT license. You are also implicitly
verifying that all code is your original work or correctly attributed
with the source of its origin and license.
See LICENSE for more information.