External module scripts/sources/photo_sources

Manage the PhotoSource objects

Index

Functions

Functions

getSelectedSources

getSelectedSources(): (GoogleSource | CCSource | FlickrSource | RedditSource | UnsplashSource)[]

- Defined in scripts/sources/photo_sources.ts:25
Get the sources that are marked true in local storage

Returns (GoogleSource | CCSource | FlickrSource | RedditSource | UnsplashSource)[]

Array of sources

getUseKeyValues

getUseKeyValues(): any[]

- Defined in scripts/sources/photo_sources.ts:45
Get all the UseKey values

Returns any[]

Array of usage keys

isUseKey

isUseKey(keyName: string): boolean

- Defined in scripts/sources/photo_sources.ts:59
Determine if a given key is a photo source

Parameters
- keyName: string
  
  key to check
Returns boolean

true if photo source

process

process(useKey: UseKey): Promise<void>

- Defined in scripts/sources/photo_sources.ts:76
Process the given photo source and save to localStorage.

throws

An error if processing failed

Parameters
- useKey: UseKey
  
  The photo source to retrieve
Returns Promise<void>

processAll

processAll(doLimited: boolean): Promise<void>

- Defined in scripts/sources/photo_sources.ts:88
Process all the selected photo sources.

Parameters
- doLimited: boolean
  
  update sources with API limits too
Returns Promise<void>

processDaily

processDaily(): Promise<void>

- Defined in scripts/sources/photo_sources.ts:106
Process all the selected photo sources that are to be updated daily

Returns Promise<void>

Generated using TypeDoc