import ByYear from 'opengate-js/src/operations/catalog/period/pattern/ByYear.js'

public class | source

ByYear

ByGeneric → ByYear

Constructor Summary

Public Constructor
public	constructor(parent: BaseOperationBuilder, date: Date, periodicityName: string, end: number or Date) Constructor

Public Methods
public	day(day: number): BaseOperationBuilder At this day will be executed the operation
public	month(month: string): BaseOperationBuilder \| ByYear At this month will be executed the operation

Constructor

Name	Type	Attribute	Description
parent	BaseOperationBuilder	nullable: false	this is a operationBaseBuilder.
date	Date	nullable: false	Date when operation will be executed
periodicityName	string		Name associated to periodicity
end	number or Date	nullable: false	When periodicity ends. By repetitions or by date

At this day will be executed the operation

Name	Type	Attribute	Description
day	number	nullable: false

Error	throw error when day is not typeof number
Error	throw error when day is > 31 and < 1

At this month will be executed the operation

Name	Type	Attribute	Description
month	string	nullable: false

Error	throw error when month is not typeof string
Error	throw error when month is not found into MONTHS_ENUM