Sommet-calendars NPM

Sommet Calendars

Te permite generar el calendario de un mes o los calendarios de todo un año. Así como facilitarte la obtención de algunas propiedades útiles para realizar operaciones con fechas.

Instalación

npm

npm i sommet-calendars

yarn

yarn add sommet-calendars

Uso

Year

var smtc = require('sommet-calemdars')

var year = new smtc.Year(2023) // Inicializa un año (Year)
var currentYear = year.getYear() // Devuelve el año del objeto
var months = year.getMonths() // Devuelve un arreglo de objetos Month
var january = year.getMonth(0) // Devuelve un objeto Month de Enero
var januaryCalendar = january.getCalendar(0) // Devuelve un arreglo de objetos Day

year.setYear(2050) // Cambia al año 2050 y devuelve el mismo objeto Year
year.nextYear() // Cambia al año siguiente (2051) y devuelve el mismo objeto Year
year.prevYear() // Cambia al año anterior (2050) y devuelve el mismo año

import { Year } from 'sommet-calendars'

const year = new Year(2023) // Inicializa un año (Year)
const currentYear = year.getYear() // Devuelve el año del objeto
const months = year.getMonths() // Devuelve un arreglo de objetos Month
const january = year.getMonth(0) // Devuelve un objeto Month de Enero
const januaryCalendar = january.getCalendar(0) // Devuelve un arreglo de objetos Day

year.setYear(2050) // Cambia al año 2050 y devuelve el mismo objeto Year
year.nextYear() // Cambia al año siguiente (2051) y devuelve el mismo objeto Year
year.prevYear() // Cambia al año anterior (2050) y devuelve el mismo año

Imprimiendo los meses de un año

const yearMonths = year.getMonths()
yearMonths.map((month) => console.log(month))

Imprimiendo todos los días del año

yearMonths.map((month) => {
	const days = month.getCalendar()
	days.map((day) => console.log(day.toDate()))
})

Month

var smtc = require('sommet-calendars')

var month = new smtc.Month(2023, 0) // Obtiene el mes de Enero del 2023

var monthName = month.getName() // Devuelve el nombre completo del mes (Enero)
var monthNum = month.getMonth() // Devuelve el mes en formato de numero (0)
var monthNameNormal = month.getName({ size: 'normal' }) // Devuelve el nombre completo del mes (Enero)
var shortMonthName = month.getName({ size: 'short' }) // Devuelve el nombre corto del mes (Ene)
var monthDays = month.getMonthDays() // Devuelve el número de días que tiene el mes
var monthYear = month.getYear() // Devulve el año al que pertenece este mes (2023)
var monthCalendar = month.getCalendar() // Obtiene el calendario de Enero del 2023
month.nextMonth() // Actualiza el mes al siguiente (Febrero 2023)
month.prevMonth() // Actualiza el mes al anterior (Enero 2023)
var nextMonth = month.getNextMonth() // Obtiene el siguiente mes devolviendo un nuevo objeto Month (Febrero 2023)
var prevMonth = month.getPrevMonth() // Obtiene el mes anterior devolviendo un nuevo objeto Month (Diciembre 2022)

import { Month } from 'sommet-calendars'

const month = new Month(2023, 0) // Obtiene el mes de Enero del 2023

const monthName = month.getName() // Devuelve el nombre completo del mes (Enero)
const monthNum = month.getMonth() // Devuelve el mes en formato de numero (0)
const monthNameNormal = month.getName({ size: 'normal' }) // Devuelve el nombre completo del mes (Enero)
const shortMonthName = month.getName({ size: 'short' }) // Devuelve el nombre corto del mes (Ene)
const monthDays = month.getMonthDays() // Devuelve el número de días que tiene el mes
const monthYear = month.getYear() // Devulve el año al que pertenece este mes (2023)
const monthCalendar = month.getCalendar() // Obtiene el calendario de Enero del 2023
month.nextMonth() // Actualiza el mes al siguiente (Febrero 2023)
month.prevMonth() // Actualiza el mes al anterior (Enero 2023)
const nextMonth = month.getNextMonth() // Devuelve un nuevo objeto Month del siguiente mes (Febrero 2023) sin actualizar el objeto principal.
const prevMonth = month.getPrevMonth() // Devuelve un nuevo objeto Month del mes anterior (Diciembre 2022) sin actualizar el objeto principal.

Imprimiendo los días de un mes

const days = month.getCalendar()
days.map((day) => console.log(day.toDate()))

Day

var smtc = require('sommet-calendars')

var date = new Date()
var day = new smtc.Day(date) // Inicializa un objeto Day

var dayNumber = day.getDay() // Devuelve el número del día
var dayMonth = day.getMonth() // Devuelve el número del mes
var dayYear = day.getYear() // Devuelve el número del año
var weekday = day.getWeekday() // Devuelve el número del día de la semana al que pertenece
var weekdayName = day.getWeekdayName() // Devuelve el nombre del día de la semana al que pertenece el día
var weekdayLgName = day.getWeekdayName({ size: 'lg' }) // Devuelve el nombre completo (Jueves) del día de la semana al que pertenece el día
var weekdayMdName = day.getWeekdayName({ size: 'md' }) // Devuelve el nombre de tamaño mediano (Jue) del día de la semana al que pertenece el día
var weekdaySmName = day.getWeekdayName({ size: 'sm' }) // Devuelve el nombre de tamaño chico (J) del día de la semana al que pertenece el día
day.isToday() // Comprueba si el día es hoy o no
day.toDate() // Devuelve el día en un objeto Date

Si están utlizando ES6:

import { Day } from 'sommet-calendars'

const date = new Date()
const day = new Day(date) // Inicializa un objeto Day

const dayNumber = day.getDay() // Devuelve el número del día
const dayMonth = day.getMonth() // Devuelve el número del mes
const dayYear = day.getYear() // Devuelve el número del año
const weekday = day.getWeekday() // Devuelve el número del día de la semana al que pertenece
const weekdayName = day.getWeekdayName() // Devuelve el nombre del día de la semana al que pertenece el día
const weekdayLgName = day.getWeekdayName({ size: 'lg' }) // Devuelve el nombre completo (Jueves) del día de la semana al que pertenece el día
const weekdayMdName = day.getWeekdayName({ size: 'md' }) // Devuelve el nombre de tamaño mediano (Jue) del día de la semana al que pertenece el día
const weekdaySmName = day.getWeekdayName({ size: 'sm' }) // Devuelve el nombre de tamaño chico (J) del día de la semana al que pertenece el día
day.isToday() // Comprueba si el día es hoy o no
day.toDate() // Devuelve el día en un objeto Date

Saber si un día es hoy

const date = new Day(new Date())
console.log(date.isToday()) // Output: true

const tomorrow = new Day(new Date(2023, 10, 3))
console.log(tomorrow.isToday()) // Output: false

Ejemplo de formatos de nombres

Month

Weekday

El día Miércoles en formato sm aparece como X para evitar confundir con el día Martes que aparece como M.

Listas de nombres

Months

Weekdays

Aunque el domingo es el primer día de la semana los días de los meses empiezan desde el lunes. Más abajo está un ejemplo de como se vería un calendario construido con este módulo.

Ejemplo de Calendario

Así es como se generan los días que están en el siguiente calendario. Incluyendo los días del mes anterior y el siguiente para que se genere el cuadro completo: