{ "author": { "email": "info@kollavarsham.org", "name": "The Kollavarsham Team", "roles": [ "author" ], "url": "https://kollavarsham.org" }, "description": "Convert Gregorian date to Kollavarsham date and vice versa", "docs": { "stability": "stable" }, "homepage": "https://kollavarsham.org", "jsiiVersion": "1.73.0 (build 6faeda3)", "keywords": [ "kollavarsham", "malayalam", "calendar", "malayalam era", "gregorian calendar", "hindu calendar", "solar calendar", "lunar calendar", "sidereal calendar", "chingam", "kanni", "thulam", "vrischikam", "dhanu", "makaram", "kumbham", "meenam", "medam", "idavam", "mithunam", "karkitakam" ], "license": "MIT", "metadata": { "jsii": { "pacmak": { "hasDefaultInterfaces": true } } }, "name": "kollavarsham", "readme": { "markdown": "# [kollavarsham](http://kollavarsham.org/)\n\n[![Circle CI Status][circleci-image]][circleci-url] [![Coverage Status][coveralls-image]][coveralls-url] [![GitHub Actions Status][gh-actions-image]][gh-actions-url] [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fkollavarsham%2Fkollavarsham-js.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fkollavarsham%2Fkollavarsham-js?ref=badge_shield)\n\n\n> Convert Gregorian date to Kollavarsham date and vice versa\n\n\n## Install\n\n### TypeScript/JavaScript/Node.js [![NPM version][npm-image]][npm-url]\n\n```sh\n$ npm install kollavarsham\n```\n\n### Python [![PyPI version][pypi-image]][pypi-url]\n\n```sh\n$ pip install kollavarsham\n```\n\n### Go [![GitHub go.mod Go version][go-mod-image]][go-mod-url]\n\n```sh\ngo get github.com/kollavarsham/kollavarsham-go/converter\n```\n\n### Java [![Maven version][maven-image]][maven-url]\n\n```xml\n\n org.kollavarsham.converter\n kollavarsham-converter\n 2.0.1\n\n```\n\n### C#/dotnet [![NuGet version][nuget-image]][nuget-url]\n\n```sh\n$ dotnet add package KollavarshamOrg.Converter\n```\n\n## Usage\n\n### TypeScript/JavaScript/Node.js\n\n```js\nimport { Kollavarsham } from 'kollavarsham';\n\nconst options = {\n system: 'SuryaSiddhanta',\n latitude: 10,\n longitude: 76.2\n};\n\nconst kollavarsham = new Kollavarsham(options);\n\nconst today = kollavarsham.fromGregorianDate(new Date());\n\nconsole.log(today.year, today.mlMasaName, today.date, `(${today.mlNaksatraName})`);\n```\n\n### Python\n\n```python\nimport datetime\nimport pytz\nimport kollavarsham\n\nnow = pytz.utc.localize(datetime.datetime.utcnow())\nkv = kollavarsham.Kollavarsham(latitude=10, longitude=76.2, system=\"SuryaSiddhanta\")\n\ntoday = kv.from_gregorian_date(date=now)\nprint(today.year, today.ml_masa_name, today.date, '(' + today.naksatra.ml_malayalam + ')')\n```\n\n### Java\n\n```java\npackage org.kollavarsham.tester;\n\nimport java.time.Instant;\n\nimport org.kollavarsham.converter.Kollavarsham;\nimport org.kollavarsham.converter.KollavarshamDate;\nimport org.kollavarsham.converter.Settings;\nimport org.kollavarsham.converter.Settings.Builder;\n\npublic class App {\n public static void main( final String[] args) {\n final Settings settings = new Builder().latitude(10).longitude(76.2).system(\"SuryaSiddhanta\").build();\n final Kollavarsham kv = new Kollavarsham(settings);\n final KollavarshamDate today = kv.fromGregorianDate(Instant.now());\n System.out.println( today.getYear() + today.getMlMasaName() + today.getDate() + '(' + today.getMlNaksatraName() + ')' );\n }\n}\n```\n\n### C#/dotnet\n\n```csharp\nusing System;\n\nnamespace KollavarshamOrg.Tester\n{\n class Program\n {\n static void Main(string[] args)\n {\n var settings = new Settings {\n Latitude = 10,\n Longitude = 76.2,\n System = \"SuryaSiddhanta\"\n };\n var kv = new Kollavarsham(settings);\n var today = kv.FromGregorianDate(DateTime.Now);\n Console.WriteLine($\"{today.Year.ToString()} {today.MlMasaName} {today.Date.ToString()} ({today.MlNaksatraName})\");\n }\n }\n}\n```\n\n## Documentation\n\n### TypeScript/JavaScript/Node.js\n\nCheck out the [Kollavarsham class](https://kollavarsham.org/kollavarsham-js/module-kollavarsham.Kollavarsham.html) within the API documentation as this is the entry point into the library.\n\n## Release History\nCheck out the history at [GitHub Releases](https://github.com/kollavarsham/kollavarsham-js/releases)\n\n## License\nCopyright (c) 2014-2023 The Kollavarsham Team. Licensed under the [MIT license](http://kollavarsham.org/LICENSE.txt).\n\n[npm-image]: https://img.shields.io/npm/v/kollavarsham\n[npm-url]: https://www.npmjs.com/package/kollavarsham\n[pypi-image]: https://img.shields.io/pypi/v/kollavarsham\n[pypi-url]: https://pypi.org/project/kollavarsham/\n[go-mod-image]: https://img.shields.io/github/go-mod/go-version/kollavarsham/kollavarsham-go\n[go-mod-url]: https://github.com/kollavarsham/kollavarsham-go\n[maven-image]: https://img.shields.io/maven-central/v/org.kollavarsham.converter/kollavarsham-converter\n[maven-url]: https://search.maven.org/artifact/org.kollavarsham.converter/kollavarsham-converter\n[nuget-image]: https://img.shields.io/nuget/v/KollavarshamOrg.Converter\n[nuget-url]: https://www.nuget.org/packages/KollavarshamOrg.Converter\n[circleci-image]: https://img.shields.io/circleci/build/github/kollavarsham/kollavarsham-js?label=CircleCI\n[circleci-url]: https://app.circleci.com/pipelines/github/kollavarsham/kollavarsham-js\n[gh-actions-image]: https://github.com/kollavarsham/kollavarsham-js/actions/workflows/ci.yml/badge.svg\n[gh-actions-url]: https://github.com/kollavarsham/kollavarsham-js/actions/workflows/ci.yml?query=branch%3Amain\n[coveralls-image]: https://img.shields.io/coveralls/github/kollavarsham/kollavarsham-js?label=Coveralls\n[coveralls-url]: https://coveralls.io/github/kollavarsham/kollavarsham-js?branch=main\n\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fkollavarsham%2Fkollavarsham-js.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fkollavarsham%2Fkollavarsham-js?ref=badge_large)\n" }, "repository": { "type": "git", "url": "https://github.com/kollavarsham/kollavarsham-js.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "iconUrl": "https://kollavarsham.org/static/images/logo.png", "namespace": "KollavarshamOrg", "packageId": "KollavarshamOrg.Converter" }, "go": { "moduleName": "github.com/kollavarsham/kollavarsham-go", "packageName": "converter" }, "java": { "maven": { "artifactId": "kollavarsham-converter", "groupId": "org.kollavarsham.converter" }, "package": "org.kollavarsham.converter" }, "js": { "npm": "kollavarsham" }, "python": { "distName": "kollavarsham", "module": "kollavarsham" } }, "types": { "kollavarsham.BaseDate": { "abstract": true, "assembly": "kollavarsham", "docs": { "custom": { "class": "BaseDate", "constructor": "true" }, "remarks": "**INTERNAL/PRIVATE**", "stability": "stable", "summary": "Serves as the base class for both the {@link JulianDate} and {@link KollavarshamDate} classes." }, "fqn": "kollavarsham.BaseDate", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 145 }, "parameters": [ { "name": "year", "optional": true, "type": { "primitive": "number" } }, { "name": "month", "optional": true, "type": { "primitive": "number" } }, { "name": "date", "optional": true, "type": { "primitive": "number" } } ], "protected": true }, "kind": "class", "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 63 }, "methods": [ { "docs": { "custom": { "for": "BaseDate", "method": "getMasaName" }, "returns": "", "stability": "stable", "summary": "Returns the month names object that has Saka, Saura and Kollavarsham (English & Malayalam) month names for the specified index `masaNumber`." }, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 213 }, "name": "getMasaName", "parameters": [ { "name": "masaNumber", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "kollavarsham.MasaName" } }, "static": true }, { "docs": { "custom": { "for": "BaseDate", "method": "toString", "type": "{string}" }, "stability": "stable", "summary": "Converts the Date to a nicely formatted string with year, month and date." }, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 201 }, "name": "toString", "returns": { "type": { "primitive": "string" } } } ], "name": "BaseDate", "properties": [ { "docs": { "custom": { "property": "mlWeekdayName", "type": "{string}" }, "stability": "stable", "summary": "Returns the weekday (in Malayalam) for the current instance of date." }, "immutable": true, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 190 }, "name": "mlWeekdayName", "type": { "primitive": "string" } }, { "docs": { "custom": { "property": "sauraMasaName", "type": "{string}" }, "stability": "stable", "summary": "Returns the Saura Masa name for the current instance of date." }, "immutable": true, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 170 }, "name": "sauraMasaName", "type": { "primitive": "string" } }, { "docs": { "custom": { "property": "weekdayName", "type": "{string}" }, "stability": "stable", "summary": "Returns the weekday (in English) for the current instance of date." }, "immutable": true, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 180 }, "name": "weekdayName", "type": { "primitive": "string" } }, { "docs": { "custom": { "property": "ahargana", "type": "{Number}" }, "remarks": "In Sanskrit `ahoratra` means one full day and `gana` means count.\nHence, the Ahargana on any given day stands for the number of lunar days that have elapsed starting from an epoch.\n\n_Source_: http://cs.annauniv.edu/insight/Reading%20Materials/astro/sharptime/ahargana.htm", "stability": "stable", "summary": "The `Ahargana` corresponding to this instance of the date. **Set separately after an instance is created**." }, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 119 }, "name": "ahargana", "type": { "primitive": "number" } }, { "docs": { "custom": { "property": "date", "type": "{Number}" }, "stability": "stable", "summary": "The date corresponding to this instance of the date." }, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 87 }, "name": "date", "type": { "primitive": "number" } }, { "docs": { "custom": { "property": "gregorianDate", "type": "{Date}" }, "remarks": "**Set separately after an instance is created**", "stability": "stable", "summary": "The gregorian date corresponding to this instance of the date." }, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 95 }, "name": "gregorianDate", "type": { "primitive": "date" } }, { "docs": { "custom": { "property": "julianDay", "type": "{Number}" }, "remarks": "**Set separately after an instance is created**\nJulian day is the continuous count of days since the beginning of the Julian Period used primarily by astronomers.\n\n_Source_: https://en.wikipedia.org/wiki/Julian_day", "stability": "stable", "summary": "The `Julian Day` corresponding to this instance of the date." }, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 106 }, "name": "julianDay", "type": { "primitive": "number" } }, { "docs": { "custom": { "property": "month", "type": "{Number}" }, "stability": "stable", "summary": "The month corresponding to this instance of the date." }, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 79 }, "name": "month", "type": { "primitive": "number" } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 156 }, "name": "naksatra", "type": { "fqn": "kollavarsham.Naksatra" } }, { "docs": { "custom": { "property": "sauraDivasa", "type": "{Number}" }, "remarks": "**Set separately after an instance is created**", "stability": "stable", "summary": "The `Saura Divasa` (Solar Calendar Day) for this instance of the date." }, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 135 }, "name": "sauraDivasa", "type": { "primitive": "number" } }, { "docs": { "custom": { "property": "sauraMasa", "type": "{Number}" }, "remarks": "**Set separately after an instance is created**", "stability": "stable", "summary": "The `Saura Masa` (Solar Calendar Month) for this instance of the date." }, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 127 }, "name": "sauraMasa", "type": { "primitive": "number" } }, { "docs": { "custom": { "property": "year", "type": "{Number}" }, "stability": "stable", "summary": "The year corresponding to this instance of the date." }, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 71 }, "name": "year", "type": { "primitive": "number" } } ], "symbolId": "lib/dates/baseDate:BaseDate" }, "kollavarsham.JulianDate": { "assembly": "kollavarsham", "base": "kollavarsham.BaseDate", "docs": { "custom": { "class": "JulianDate", "constructor": "true", "extends": "BaseDate" }, "remarks": "**INTERNAL/PRIVATE**", "stability": "stable", "summary": "Represents a Julian date's year, month and day `toGregorianDateFromSaka` method of the {@link Kollavarsham} class returns an instance of this type for dates older than `1st January 1583 AD`." }, "fqn": "kollavarsham.JulianDate", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/dates/julianDate.ts", "line": 30 }, "parameters": [ { "name": "year", "optional": true, "type": { "primitive": "number" } }, { "name": "month", "optional": true, "type": { "primitive": "number" } }, { "name": "day", "optional": true, "type": { "primitive": "number" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dates/julianDate.ts", "line": 28 }, "name": "JulianDate", "symbolId": "lib/dates/julianDate:JulianDate" }, "kollavarsham.Kollavarsham": { "assembly": "kollavarsham", "docs": { "custom": { "class": "Kollavarsham", "constructor": "true" }, "example": "const Kollavarsham = require('kollavarsham');\n\nconst options = {\n system: 'SuryaSiddhanta',\n latitude: 10,\n longitude: 76.2\n};\n\nconst kollavarsham = new Kollavarsham(options);\n\nlet todayInMalayalamEra = kollavarsham.fromGregorianDate(new Date());\n\nlet today = kollavarsham.toGregorianDate(todayInMalayalamEra); // Not implemented yet", "remarks": "Create a new instance of this class, passing in the relevant options and call methods on the instance.", "stability": "stable", "summary": "The Kollavarsham class implements all the public APIs of the library." }, "fqn": "kollavarsham.Kollavarsham", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/index.ts", "line": 52 }, "parameters": [ { "name": "options", "optional": true, "type": { "fqn": "kollavarsham.Settings" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/index.ts", "line": 49 }, "methods": [ { "docs": { "custom": { "for": "Kollavarsham", "method": "fromGregorianDate" }, "example": "const Kollavarsham = require('Kollavarsham');\nconst kollavarsham = new Kollavarsham();\nlet today = kollavarsham.fromGregorianDate(new Date(1979, 4, 22));", "returns": "Converted date", "stability": "stable", "summary": "Converts a Gregorian date to the equivalent Kollavarsham date, respecting the current configuration." }, "locationInModule": { "filename": "lib/index.ts", "line": 77 }, "name": "fromGregorianDate", "parameters": [ { "docs": { "summary": "The Gregorian date to be converted to Kollavarsham." }, "name": "date", "type": { "primitive": "date" } } ], "returns": { "type": { "fqn": "kollavarsham.KollavarshamDate" } } }, { "docs": { "custom": { "for": "Kollavarsham", "method": "toGregorianDate", "throws": "**\"When the API is implemented, will convert <date>\"**" }, "remarks": "This method Will return {@link JulianDate} object for any date before 1st January 1583 AD and\n[Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) objects for later dates.\n\n **This API has not been implemented yet**", "returns": "Converted date", "stability": "stable", "summary": "Converts a Kollavarsham date (an instance of {@link kollavarshamDate}) to its equivalent Gregorian date, respecting the current configuration." }, "locationInModule": { "filename": "lib/index.ts", "line": 95 }, "name": "toGregorianDate", "parameters": [ { "docs": { "summary": "The Kollavarsham date to be converted to Gregorian." }, "name": "date", "type": { "fqn": "kollavarsham.KollavarshamDate" } } ], "returns": { "type": { "primitive": "date" } } }, { "docs": { "custom": { "for": "Kollavarsham", "method": "toGregorianDateFromSaka" }, "remarks": "This method Will return {@link JulianDate} object for any date before 1st January 1583 AD and\n[Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) objects for later dates.", "returns": "Converted date", "stability": "stable", "summary": "Converts a Saka date (an instance of {@link sakaDate}) to its equivalent Gregorian date, respecting the current configuration." }, "locationInModule": { "filename": "lib/index.ts", "line": 110 }, "name": "toGregorianDateFromSaka", "parameters": [ { "docs": { "summary": "The Saka date to be converted to Gregorian." }, "name": "sakaDate", "type": { "fqn": "kollavarsham.SakaDate" } } ], "returns": { "type": { "fqn": "kollavarsham.KollavarshamDate" } } } ], "name": "Kollavarsham", "properties": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/index.ts", "line": 50 }, "name": "settings", "type": { "fqn": "kollavarsham.Settings" } } ], "symbolId": "lib/index:Kollavarsham" }, "kollavarsham.KollavarshamDate": { "assembly": "kollavarsham", "base": "kollavarsham.BaseDate", "docs": { "custom": { "class": "KollavarshamDate", "constructor": "true", "extends": "BaseDate" }, "stability": "stable", "summary": "Represents a Kollavarsham date's year, month and date." }, "fqn": "kollavarsham.KollavarshamDate", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/dates/kollavarshamDate.ts", "line": 27 }, "parameters": [ { "name": "year", "optional": true, "type": { "primitive": "number" } }, { "name": "month", "optional": true, "type": { "primitive": "number" } }, { "name": "day", "optional": true, "type": { "primitive": "number" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dates/kollavarshamDate.ts", "line": 24 }, "name": "KollavarshamDate", "properties": [ { "docs": { "custom": { "property": "masaName", "type": "{string}" }, "stability": "stable", "summary": "Returns the Kollavarsham month name (in English) for this instance of date." }, "immutable": true, "locationInModule": { "filename": "lib/dates/kollavarshamDate.ts", "line": 59 }, "name": "masaName", "type": { "primitive": "string" } }, { "docs": { "custom": { "property": "mlMasaName", "type": "{string}" }, "stability": "stable", "summary": "Returns the Kollavarsham month name (in Malayalam) for this instance of date." }, "immutable": true, "locationInModule": { "filename": "lib/dates/kollavarshamDate.ts", "line": 69 }, "name": "mlMasaName", "type": { "primitive": "string" } }, { "docs": { "custom": { "property": "mlNaksatraName", "type": "{string}" }, "stability": "stable", "summary": "Returns the Kollavarsham Naksatra name (in Malayalam) for this instance of date." }, "immutable": true, "locationInModule": { "filename": "lib/dates/kollavarshamDate.ts", "line": 49 }, "name": "mlNaksatraName", "type": { "primitive": "string" } }, { "docs": { "custom": { "property": "naksatraName", "type": "{string}" }, "stability": "stable", "summary": "Returns the Kollavarsham Naksatra name (in English) for this instance date." }, "immutable": true, "locationInModule": { "filename": "lib/dates/kollavarshamDate.ts", "line": 39 }, "name": "naksatraName", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/dates/kollavarshamDate.ts", "line": 25 }, "name": "sakaDate", "type": { "fqn": "kollavarsham.SakaDate" } } ], "symbolId": "lib/dates/kollavarshamDate:KollavarshamDate" }, "kollavarsham.MasaName": { "assembly": "kollavarsham", "datatype": true, "docs": { "stability": "stable" }, "fqn": "kollavarsham.MasaName", "kind": "interface", "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 25 }, "name": "MasaName", "properties": [ { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 28 }, "name": "enMalayalam", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 29 }, "name": "mlMalayalam", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 26 }, "name": "saka", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 27 }, "name": "saura", "type": { "primitive": "string" } } ], "symbolId": "lib/dates/baseDate:MasaName" }, "kollavarsham.Naksatra": { "assembly": "kollavarsham", "datatype": true, "docs": { "stability": "stable" }, "fqn": "kollavarsham.Naksatra", "kind": "interface", "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 19 }, "name": "Naksatra", "properties": [ { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 21 }, "name": "enMalayalam", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 22 }, "name": "mlMalayalam", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/dates/baseDate.ts", "line": 20 }, "name": "saka", "type": { "primitive": "string" } } ], "symbolId": "lib/dates/baseDate:Naksatra" }, "kollavarsham.SakaDate": { "assembly": "kollavarsham", "base": "kollavarsham.BaseDate", "docs": { "custom": { "class": "SakaDate", "constructor": "true", "extends": "BaseDate" }, "stability": "stable", "summary": "Represents an Saka date's year, month and paksa and tithi." }, "fqn": "kollavarsham.SakaDate", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 85 }, "parameters": [ { "name": "year", "optional": true, "type": { "primitive": "number" } }, { "name": "month", "optional": true, "type": { "primitive": "number" } }, { "name": "tithi", "optional": true, "type": { "primitive": "number" } }, { "name": "paksa", "optional": true, "type": { "primitive": "string" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 26 }, "methods": [ { "docs": { "custom": { "for": "SakaDate", "method": "generateKollavarshamDate" }, "returns": "", "stability": "stable", "summary": "Generates an instance of {@link KollavarshamDate} from this instance of SakaDate." }, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 160 }, "name": "generateKollavarshamDate", "returns": { "type": { "fqn": "kollavarsham.KollavarshamDate" } } }, { "docs": { "stability": "stable", "summary": "Converts the Date to a nicely formatted string with year, month and date." }, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 183 }, "name": "toString", "overrides": "kollavarsham.BaseDate", "returns": { "type": { "primitive": "string" } } } ], "name": "SakaDate", "properties": [ { "docs": { "custom": { "property": "masaName", "type": "{string}" }, "stability": "stable", "summary": "Returns the month name for this instance of SakaDate." }, "immutable": true, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 149 }, "name": "masaName", "type": { "primitive": "string" } }, { "docs": { "custom": { "property": "naksatraName", "type": "{string}" }, "stability": "stable", "summary": "Returns the Saka Naksatra name for this instance of SakaDate." }, "immutable": true, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 139 }, "name": "naksatraName", "type": { "primitive": "string" } }, { "docs": { "custom": { "property": "sakaYear", "type": "{Number}" }, "stability": "stable", "summary": "Returns the Saka year on this instance of SakaDate (same as the underlyiung `year` property from the {@link BaseDate} class)." }, "immutable": true, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 104 }, "name": "sakaYear", "type": { "primitive": "number" } }, { "docs": { "custom": { "property": "tithi", "type": "{Number}" }, "remarks": "In Vedic timekeeping, a tithi (also spelled thithi) is a lunar day, or the time it takes for the longitudinal angle between the Moon and the Sun to increase by 12°.\nTithis begin at varying times of day and vary in duration from approximately 19 to approximately 26 hours.\n\n_Source_: https://en.wikipedia.org/wiki/Tithi", "stability": "stable", "summary": "Returns the Tithi on this instance of SakaDate (same as the underlyiung `date` property from the {@link BaseDate} class)." }, "immutable": true, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 119 }, "name": "tithi", "type": { "primitive": "number" } }, { "docs": { "custom": { "property": "vikramaYear", "type": "{Number}" }, "stability": "stable", "summary": "Returns the Vikrama year corresponding to the Saka year of this instance." }, "immutable": true, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 129 }, "name": "vikramaYear", "type": { "primitive": "number" } }, { "docs": { "custom": { "property": "adhimasa", "type": "{string}" }, "remarks": "**Set separately after an instance is created**", "stability": "stable", "summary": "The Adhimasa (`Adhika Masa`) prefix corresponding to this instance of the date." }, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 54 }, "name": "adhimasa", "type": { "primitive": "string" } }, { "docs": { "custom": { "property": "fractionalTithi", "type": "{Number}" }, "remarks": "**Set separately after an instance is created**", "stability": "stable", "summary": "The fractional `Tithi`corresponding to this instance of the date." }, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 62 }, "name": "fractionalTithi", "type": { "primitive": "number" } }, { "docs": { "custom": { "property": "kaliYear", "type": "{Number}" }, "remarks": "**Set separately after an instance is created**", "stability": "stable", "summary": "The Kali year corresponding to this instance of the date." }, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 46 }, "name": "kaliYear", "type": { "primitive": "number" } }, { "docs": { "stability": "stable", "summary": "The original ahargana passed in to the celestial calculations (TODO: Not sure why we need this!?)." }, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 83 }, "name": "originalAhargana", "type": { "primitive": "number" } }, { "docs": { "custom": { "property": "paksa", "type": "{string}" }, "remarks": "Paksha (or pakṣa: Sanskrit: पक्ष), refers to a fortnight or a lunar phase in a month of the Hindu lunar calendar.\n\n_Source_: https://en.wikipedia.org/wiki/Paksha", "stability": "stable", "summary": "The Paksha/Paksa corresponding to this instance of the date." }, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 38 }, "name": "paksa", "type": { "primitive": "string" } }, { "docs": { "custom": { "property": "sunriseHour", "type": "{Number}" }, "remarks": "**Set separately after an instance is created**", "stability": "stable", "summary": "The hour part from the sunrise time for this date." }, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 70 }, "name": "sunriseHour", "type": { "primitive": "number" } }, { "docs": { "custom": { "property": "sunriseMinute", "type": "{Number}" }, "remarks": "**Set separately after an instance is created**", "stability": "stable", "summary": "The minute part from the sunrise time for this date." }, "locationInModule": { "filename": "lib/dates/sakaDate.ts", "line": 78 }, "name": "sunriseMinute", "type": { "primitive": "number" } } ], "symbolId": "lib/dates/sakaDate:SakaDate" }, "kollavarsham.Settings": { "assembly": "kollavarsham", "datatype": true, "docs": { "stability": "stable" }, "fqn": "kollavarsham.Settings", "kind": "interface", "locationInModule": { "filename": "lib/index.ts", "line": 15 }, "name": "Settings", "properties": [ { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/index.ts", "line": 17 }, "name": "latitude", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/index.ts", "line": 18 }, "name": "longitude", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/index.ts", "line": 16 }, "name": "system", "type": { "primitive": "string" } } ], "symbolId": "lib/index:Settings" } }, "version": "2.4.10", "fingerprint": "S1jYhbh9KgPXxKsmqLvN9LRhQPqCgvKIoA4y/GvRAqk=" }