SunCalc 技术文档

本文档将详细介绍如何安装、使用以及API调用方式，帮助用户更好地理解并使用 SunCalc 项目。

1. 安装指南

在开始使用 SunCalc 之前，您需要先安装它。以下是安装步骤：

$ npm install suncalc

2. 项目使用说明

SunCalc 是一个基于 JavaScript 的库，用于计算太阳和月亮的位置以及昼夜变化时间。以下是基本的使用示例：

计算昼夜变化时间

// 获取今天伦敦的昼夜变化时间
var times = SunCalc.getTimes(new Date(), 51.5, -0.1);

计算太阳位置

// 获取今天日出时太阳的位置
var sunrisePos = SunCalc.getPosition(times.sunrise, 51.5, -0.1);

计算月亮位置

// 获取当前时间月亮的位置
var moonPos = SunCalc.getMoonPosition(new Date(), 51.5, -0.1);

计算月亮照亮分数

// 获取当前时间的月亮照亮分数
var moonIllumination = SunCalc.getMoonIllumination(new Date());

3. 项目API使用文档

以下是 SunCalc 项目的 API 文档，详细介绍了每个函数的用法。

昼夜变化时间

SunCalc.getTimes(date, latitude, longitude, [height])

• 参数:

  • date: 日期对象。
  • latitude: 纬度。
  • longitude: 经度。
  • height: 高度（可选，默认为0）。

• 返回值:

  • 返回一个包含昼夜变化时间的对象。

添加自定义时间

SunCalc.addTime(angleInDegrees, morningName, eveningName)

• 参数:
  • angleInDegrees: 太阳达到的角度。
  • morningName: 早上时间的名称。
  • eveningName: 晚上时间的名称。

计算太阳位置

SunCalc.getPosition(timeAndDate, latitude, longitude)

• 参数:

  • timeAndDate: 日期对象。
  • latitude: 纬度。
  • longitude: 经度。

• 返回值:

  • 返回一个包含太阳位置的对象。

计算月亮位置

SunCalc.getMoonPosition(timeAndDate, latitude, longitude)

• 参数:

  • timeAndDate: 日期对象。
  • latitude: 纬度。
  • longitude: 经度。

• 返回值:

  • 返回一个包含月亮位置的对象。

计算月亮照亮分数

SunCalc.getMoonIllumination(timeAndDate)

• 参数:

  • timeAndDate: 日期对象。

• 返回值:

  • 返回一个包含月亮照亮分数的对象。

计算月亮升起和落下时间

SunCalc.getMoonTimes(date, latitude, longitude[, inUTC])

• 参数:

  • date: 日期对象。
  • latitude: 纬度。
  • longitude: 经度。
  • inUTC: 是否使用 UTC 时间（可选）。

• 返回值:

  • 返回一个包含月亮升起和落下时间的对象。

4. 项目安装方式

SunCalc 项目可以通过 npm 进行安装。以下是安装命令：

$ npm install suncalc

通过以上内容，您应该能够顺利安装并使用 SunCalc 项目，同时理解其提供的 API 及其用法。