moon-sighting/.github/wiki/api/functions/downloadKernels.md
Aric Camarata 2992dcee21 docs: add TypeDoc API generation (typedoc@0.28.19 + typedoc-plugin-markdown@4.11.0)
Add typedoc and typedoc-plugin-markdown as devDependencies. Add typedoc.json config
targeting src/index.ts with markdown output to .github/wiki/api. Add docs script to
package.json. Generate initial API reference pages.

Part of T-E8-03 — TypeDoc automation for all 12 JS/TS packages.
2026-05-30 16:41:59 -04:00

29 lines
847 B
Markdown

[**moon-sighting v1.1.1**](../README.md)
***
[moon-sighting](../README.md) / downloadKernels
# Function: downloadKernels()
> **downloadKernels**(`config?`): `Promise`\<\{ `leapSecondsPath`: `string`; `planetaryPath`: `string`; \}\>
Defined in: [api/index.ts:159](https://github.com/acamarata/moon-sighting/blob/89fb490051d0263a7d41c954161fb945f1569805/src/api/index.ts#L159)
Download the DE442S planetary kernel and naif0012.tls leap-second kernel
to the local cache directory. Verifies the download by SHA-256 checksum
when a checksum is supplied via config.checksumOverride.
## Parameters
### config?
[`KernelConfig`](../interfaces/KernelConfig.md)
Optional kernel config (to customize cache directory or checksum)
## Returns
`Promise`\<\{ `leapSecondsPath`: `string`; `planetaryPath`: `string`; \}\>
Paths where kernels were saved