Skip to content

Commit 356475d

Browse files
committed
more docs
1 parent 2e5f964 commit 356475d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/options.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,14 @@ export interface FeedOptions {
1313

1414
/**
1515
* Merges the passed options and the options in the settings
16+
* - IO_KEY: (required) access key
17+
* - IO_FEED: feed name
18+
* - IO_USER: io.adafruit.com user name
19+
* - IO_LAT: (optional) latitude (as a number)
20+
* - IO_LON: (optional) longitude (as a number)
21+
* - IO_ELE: (optional) elevation (as a number)
1622
* @param options
17-
* @returns a valid option object
23+
* @returns a valid option object, including the key
1824
* @throws Error missing user or feed information
1925
*/
2026
export async function loadOptions(

0 commit comments

Comments
 (0)