1. module argon2
   1. function argon2.generateSalt (length)
   2. function argon2.hash (plain, salt, options)
   3. function argon2.verify (hash, plain)
   4. number argon2.argon2d
   5. number argon2.argon2i
   6. number argon2.argon2id
   7. object argon2.defaults
   8. object argon2.limits

module argon2

function argon2.generateSalt (length)

• description and source-code

  generateSalt(length) {
    return new Promise((resolve, reject) => {
      crypto.randomBytes(length || 16, (err, salt) => {
        /* istanbul ignore if */
        if (err) {
          reject(err)
        }
        resolve(salt)
      })
    })
  }

• example usage

  ...
  }
  ```
  
  You can provide your own salt as the second parameter. It is **highly**
  recommended to use the salt generating methods instead of a hardcoded, constant
  salt:
  ```js
  argon2.generateSalt().then(salt => {
    // ...
  });
  
  // ES7 or TypeScript
  
  const salt = await argon2.generateSalt();
  ```
  ...

function argon2.hash (plain, salt, options)

• description and source-code

  hash(plain, salt, options) {
    salt = new Buffer(salt)
    options = Object.assign({}, defaults, options)
  
    return validate(salt, options).then(() => new Promise((resolve, reject) => {
      bindings.hash(new Buffer(plain), salt, options, resolve, reject)
    }))
  }

• example usage

  ...
  argon2id,
  
  hash(plain, salt, options) {
    salt = new Buffer(salt)
    options = Object.assign({}, defaults, options)
  
    return validate(salt, options).then(() => new Promise((resolve, reject) => {
      bindings.hash(new Buffer(plain), salt, options, resolve, reject)
    }))
  },
  
  generateSalt(length) {
    return new Promise((resolve, reject) => {
      crypto.randomBytes(length || 16, (err, salt) => {
        /* istanbul ignore if */
  ...

function argon2.verify (hash, plain)

• description and source-code

  verify(hash, plain) {
    if (!/^\$argon2(i|d|id)(\$v=\d+)?\$m=\d+,t=\d+,p=\d+(?:\$[\w+/]+){2}$/.test(hash)) {
      return Promise.reject(new Error('Invalid hash, must be in MCF, generated by Argon2.'))
    }
  
    return new Promise((resolve, reject) => {
      bindings.verify(new Buffer(hash), new Buffer(plain), resolve, reject)
    })
  }

• example usage

  ...
  
    verify(hash, plain) {
      if (!/^\$argon2(i|d|id)(\$v=\d+)?\$m=\d+,t=\d+,p=\d+(?:\$[\w+/]+){2}$/.test(hash)) {
        return Promise.reject(new Error('Invalid hash, must be in MCF, generated by Argon2.'))
      }
  
      return new Promise((resolve, reject) => {
        bindings.verify(new Buffer(hash), new Buffer(plain), resolve, reject)
      })
    }
  }
  ...