parseAuthorString

Type:Function
Status:stable
Since:1.0.0
Platform:jsnode
@blackbyte.sugar.shared.package

This function simply take an author string like “Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)” and transform it into a plain object with these properties: name, email and url

Params

  1. string*-String

    The string to parse

Return

  1. -Object

    The plain object version of the string

Example

import { parseAuthorString } from '@blackbyte/sugar/package';
 parseAuthorString("Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)")
// => {
  "name": "Olivier Bossel",
  "email": "olivier.bossel@gmail.com",
  "url": "https://olivierbossel.com"
}

Todo

  • testsnormal