archive.social/docs/utils/AccessKeys.md

AccessKeys

thread-keeper

Author: The Harvard Library Innovation Lab
License: MIT

• AccessKeys
  • .AccessKeys
    • new exports.AccessKeys()
    • .filepath : string
    • .check(accessKey)

AccessKeys.AccessKeys

Utility class for handling access keys to the app. [!] For alpha launch only.

Kind: static class of AccessKeys

• .AccessKeys
  • new exports.AccessKeys()
  • .filepath : string
  • .check(accessKey)

new exports.AccessKeys()

On init:

• Create access keys file if it doesn't exist
• Load keys from file into this.#keys.

accessKeys.filepath : string

Complete path to access-keys.json.

Kind: instance property of AccessKeys

accessKeys.check(accessKey)

Checks that a given access key is valid and active.

Kind: instance method of AccessKeys

Param	Type
accessKey	string