https://github.com/delucis/whorl

✏️❔ Find out who the author(s) is/are from an input URL
https://github.com/delucis/whorl

author-identification metadata-extraction scraper

Last synced: 12 days ago
JSON representation

✏️❔ Find out who the author(s) is/are from an input URL

• Host: GitHub
• URL: https://github.com/delucis/whorl
• Owner: delucis
• License: gpl-3.0
• Created: 2017-09-01T15:40:09.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-01T14:09:49.000Z (about 1 year ago)
• Last Synced: 2024-11-02T12:42:42.654Z (about 2 months ago)
• Topics: author-identification, metadata-extraction, scraper
• Language: JavaScript
• Homepage:
• Size: 522 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# whorl ✏️❔

[![npm version](https://img.shields.io/npm/v/whorl.svg)](https://www.npmjs.com/package/whorl) [![Build Status](https://travis-ci.com/delucis/whorl.svg?branch=master)](https://travis-ci.com/delucis/whorl) [![Coverage Status](https://coveralls.io/repos/github/delucis/whorl/badge.svg?branch=master)](https://coveralls.io/github/delucis/whorl?branch=master) [![Known Vulnerabilities](https://snyk.io/test/npm/whorl/badge.svg)](https://snyk.io/test/npm/whorl) 

IPA: /huˌɑɹˈɛl/

**⚠️ WORK IN PROGRESS ⚠️**

Find out who the author(s) is/are from an input URL.

## Installation

```sh

npm install --save whorl

```

## Usage

```js

const WHORL = require('whorl')

WHORL('http://www.nytimes.com/2007/05/13/us/13names.html')

  .then((name) => {

    console.log(name) // ⇒ 'The Associated Press'

  })

```

If no author(s) can be deduced or the input URL is not valid, `whorl` will return `null`.

## Accuracy

Read [the latest test results](bench/benchmark.md).

## API

### whorl(url)

Returns a `Promise` for an author `String`.

#### url

Type: `String`

The URL for which to retrieve an author string.