afinn-111

afinn-111

afinn-111.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • afinn111
• Notes
• Types
• Compatibility
• Related
• Contribute
• Security
• License

What is this?

This package gives you easy access to afinn-111.

When should I use this?

You’re probably dealing with natural language, and know you need this, if you’re here!

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+), install with npm:

npm install afinn-111

In Deno with esm.sh:

import {afinn111} from 'https://esm.sh/afinn-111@2'

In browsers with esm.sh:

<script type="module">
  import {afinn111} from 'https://esm.sh/afinn-111@2?bundle'
</script>

Use

import {afinn111} from 'afinn-111'

afinn111.positive //=> 2
afinn111['self-deluded'] //=> -2

API

This package exports the identifier afinn111. There is no default export.

afinn111

afinn-111 maps entries to valence ratings (Object.<string, number>).

👉 Note: Be careful when accessing unknown properties on the afinn-111 object, words such as “constructor” or “toString” might occur. It’s recommended to use a hasOwnProperty check beforehand.

Notes

Note the AFINN entries are:

• all lower case
• can contain numbers (only case: n00b)
• can contain spaces (cases: can't stand, cashing in, cool stuff, does not work, dont like, fed up, green wash, green washing, messing up, no fun, not good, not working, right direction, screwed up, some kind)
• can contain apostrophes (only case: can't stand)
• can contain diaeresis (only case: naïve)
• can contain dashes (cases: cover-up, made-up, once-in-a-lifetime, self-confident, self-deluded, short-sighted, short-sightedness, son-of-a-bitch)

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+, 16.0+, and 18.0+. It also works in Deno and modern browsers.

Related

• afinn-96 — AFINN list from 2009, containing 1468 entries
• afinn-165 — AFINN list from 2015, containing 3382 entries
• emoji-emotion — Like AFINN, but for emoji
• polarity — Detect the polarity of text, based on afinn-165 and emoji-emotion

Contribute

Yes please! See How to Contribute to Open Source.

Security

This package is safe.

License

MIT © Titus Wormer