naming-language-generator v0.8.0

Naming language generator

This is code for generating a 'naming language', using the algorithm behind @unchartedatlas. For more details, see these notes.

Example Codepen

Classes

Language

A generated language.

Kind: global class

• Language
  • new Language()
  • new Language()
  • .spell() ⇒ String
  • .makeSyllable() ⇒ String
  • .makeWord(key) ⇒ String
  • .getMorpheme(key) ⇒ String
  • .getWord(key) ⇒ String
  • .getName(key) ⇒ String
  • .spell() ⇒ String
  • .makeSyllable() ⇒ String
  • .makeWord(key) ⇒ String
  • .makeMorpheme(key) ⇒ String
  • .getMorpheme([key]) ⇒ String
  • .getWord(key) ⇒ String
  • .makeName(key) ⇒ String
  • .translateWord(word) ⇒ String

new Language()

constructor

new Language()

constructor

language.spell() ⇒ String

spell

Kind: instance method of Language
Returns: String - A generated syllable.

language.makeSyllable() ⇒ String

makeSyllable

Kind: instance method of Language
Returns: String - A generated syllable.

language.makeWord(key) ⇒ String

Generate a word from morphemes.

Kind: instance method of Language
Returns: String - The generated word.

language.getMorpheme(key) ⇒ String

Gets a morpheme.

Kind: instance method of Language
Returns: String - The generated morpheme.

language.getWord(key) ⇒ String

Generates a word.

Kind: instance method of Language
Returns: String - The generated word.

language.getName(key) ⇒ String

Generates a name from words.

Kind: instance method of Language
Returns: String - The generated name.

language.spell() ⇒ String

spell

Kind: instance method of Language
Returns: String - A generated syllable.

language.makeSyllable() ⇒ String

makeSyllable

Kind: instance method of Language
Returns: String - A generated syllable.

language.makeWord(key) ⇒ String

Generate a new word associated with the key from morphemes. I.e. Create a new coded word for 'city'.

Kind: instance method of Language
Returns: String - The generated word.

language.makeMorpheme(key) ⇒ String

Create a new morpheme associated with a key. i.e. land -> country, land This would be turned into words later like hillCountry or lakeLand

Kind: instance method of Language
Returns: String - The generated morpheme.

language.getMorpheme(key) ⇒ String

Get a random morpheme associated with the key.

Kind: instance method of Language
Returns: String - The morpheme.

language.getWord(key) ⇒ String

Generates a word.

Kind: instance method of Language
Returns: String - The generated word.

language.makeName(key) ⇒ String

Generates a name from words.

Kind: instance method of Language
Returns: String - The generated name.

language.translateWord(word) ⇒ String

Get the key for which the word was coded. This is not a real translation, but rather the stem concept for a word.

Kind: instance method of Language
Returns: String - The translated word.

OrthoLanguage ⇐ Language

OrthoLanguage

Kind: global class
Extends: Language

• OrthoLanguage ⇐ Language
  • new OrthoLanguage()
  • .spell() ⇒ String
  • .makeSyllable() ⇒ String
  • .makeWord(key) ⇒ String
  • .getMorpheme(key) ⇒ String
  • .getWord(key) ⇒ String
  • .getName(key) ⇒ String
  • .makeMorpheme(key) ⇒ String
  • .makeName(key) ⇒ String
  • .translateWord(word) ⇒ String

new OrthoLanguage()

constructor

orthoLanguage.spell() ⇒ String

spell

Kind: instance method of OrthoLanguage
Overrides: spell
Returns: String - A generated syllable.

orthoLanguage.makeSyllable() ⇒ String

makeSyllable

Kind: instance method of OrthoLanguage
Overrides: makeSyllable
Returns: String - A generated syllable.

orthoLanguage.makeWord(key) ⇒ String

Generate a word from morphemes.

Kind: instance method of OrthoLanguage
Overrides: makeWord
Returns: String - The generated word.

orthoLanguage.getMorpheme(key) ⇒ String

Gets a morpheme.

Kind: instance method of OrthoLanguage
Overrides: getMorpheme
Returns: String - The generated morpheme.

orthoLanguage.getWord(key) ⇒ String

Generates a word.

Kind: instance method of OrthoLanguage
Overrides: getWord
Returns: String - The generated word.

orthoLanguage.getName(key) ⇒ String

Generates a name from words.

Kind: instance method of OrthoLanguage
Returns: String - The generated name.

orthoLanguage.makeMorpheme(key) ⇒ String

Create a new morpheme associated with a key. i.e. land -> country, land This would be turned into words later like hillCountry or lakeLand

Kind: instance method of OrthoLanguage
Returns: String - The generated morpheme.

orthoLanguage.makeName(key) ⇒ String

Generates a name from words.

Kind: instance method of OrthoLanguage
Returns: String - The generated name.

orthoLanguage.translateWord(word) ⇒ String

Get the key for which the word was coded. This is not a real translation, but rather the stem concept for a word.

Kind: instance method of OrthoLanguage
Returns: String - The translated word.

RandomLanguage ⇐ Language

RandomLanguage

Kind: global class
Extends: Language

• RandomLanguage ⇐ Language
  • new RandomLanguage()
  • .spell() ⇒ String
  • .makeSyllable() ⇒ String
  • .makeWord(key) ⇒ String
  • .getMorpheme(key) ⇒ String
  • .getWord(key) ⇒ String
  • .getName(key) ⇒ String
  • .makeMorpheme(key) ⇒ String
  • .makeName(key) ⇒ String
  • .translateWord(word) ⇒ String

new RandomLanguage()

constructor

randomLanguage.spell() ⇒ String

spell

Kind: instance method of RandomLanguage
Overrides: spell
Returns: String - A generated syllable.

randomLanguage.makeSyllable() ⇒ String

makeSyllable

Kind: instance method of RandomLanguage
Overrides: makeSyllable
Returns: String - A generated syllable.

randomLanguage.makeWord(key) ⇒ String

Generate a word from morphemes.

Kind: instance method of RandomLanguage
Overrides: makeWord
Returns: String - The generated word.

randomLanguage.getMorpheme(key) ⇒ String

Gets a morpheme.

Kind: instance method of RandomLanguage
Overrides: getMorpheme
Returns: String - The generated morpheme.

randomLanguage.getWord(key) ⇒ String

Generates a word.

Kind: instance method of RandomLanguage
Overrides: getWord
Returns: String - The generated word.

randomLanguage.getName(key) ⇒ String

Generates a name from words.

Kind: instance method of RandomLanguage
Returns: String - The generated name.

randomLanguage.makeMorpheme(key) ⇒ String

Create a new morpheme associated with a key. i.e. land -> country, land This would be turned into words later like hillCountry or lakeLand

Kind: instance method of RandomLanguage
Returns: String - The generated morpheme.

randomLanguage.makeName(key) ⇒ String

Generates a name from words.

Kind: instance method of RandomLanguage
Returns: String - The generated name.

randomLanguage.translateWord(word) ⇒ String

Get the key for which the word was coded. This is not a real translation, but rather the stem concept for a word.

Kind: instance method of RandomLanguage
Returns: String - The translated word.

Random

Random

Kind: global class

• Random
  • .shuffle(list) ⇒ Array
  • .getRandomFromArray(arr) ⇒ *
  • .randomIntBetween(min, max) ⇒ Number

random.shuffle(list) ⇒ Array

Randomize an array

Kind: instance method of Random
Returns: Array - A randomized copy of the original array.

random.getRandomFromArray(arr) ⇒ *

Get a random element from the array

Kind: instance method of Random
Returns: * - The random element chosen.

random.randomIntBetween(min, max) ⇒ Number

Get a random integer between two numbers.

Kind: instance method of Random
Returns: Number - The random integer.

Language

A generated language.

Kind: global class

• Language
  • new Language()
  • new Language()
  • .spell() ⇒ String
  • .makeSyllable() ⇒ String
  • .makeWord(key) ⇒ String
  • .getMorpheme(key) ⇒ String
  • .getWord(key) ⇒ String
  • .getName(key) ⇒ String
  • .spell() ⇒ String
  • .makeSyllable() ⇒ String
  • .makeWord(key) ⇒ String
  • .makeMorpheme(key) ⇒ String
  • .getMorpheme([key]) ⇒ String
  • .getWord(key) ⇒ String
  • .makeName(key) ⇒ String
  • .translateWord(word) ⇒ String

new Language()

constructor

new Language()

constructor

language.spell() ⇒ String

spell

Kind: instance method of Language
Returns: String - A generated syllable.

language.makeSyllable() ⇒ String

makeSyllable

Kind: instance method of Language
Returns: String - A generated syllable.

language.makeWord(key) ⇒ String

Generate a word from morphemes.

Kind: instance method of Language
Returns: String - The generated word.

language.getMorpheme(key) ⇒ String

Gets a morpheme.

Kind: instance method of Language
Returns: String - The generated morpheme.

language.getWord(key) ⇒ String

Generates a word.

Kind: instance method of Language
Returns: String - The generated word.

language.getName(key) ⇒ String

Generates a name from words.

Kind: instance method of Language
Returns: String - The generated name.

language.spell() ⇒ String

spell

Kind: instance method of Language
Returns: String - A generated syllable.

language.makeSyllable() ⇒ String

makeSyllable

Kind: instance method of Language
Returns: String - A generated syllable.

language.makeWord(key) ⇒ String

Generate a new word associated with the key from morphemes. I.e. Create a new coded word for 'city'.

Kind: instance method of Language
Returns: String - The generated word.

language.makeMorpheme(key) ⇒ String

Create a new morpheme associated with a key. i.e. land -> country, land This would be turned into words later like hillCountry or lakeLand

Kind: instance method of Language
Returns: String - The generated morpheme.

language.getMorpheme(key) ⇒ String

Get a random morpheme associated with the key.

Kind: instance method of Language
Returns: String - The morpheme.

language.getWord(key) ⇒ String

Generates a word.

Kind: instance method of Language
Returns: String - The generated word.

language.makeName(key) ⇒ String

Generates a name from words.

Kind: instance method of Language
Returns: String - The generated name.

language.translateWord(word) ⇒ String

Get the key for which the word was coded. This is not a real translation, but rather the stem concept for a word.

Kind: instance method of Language
Returns: String - The translated word.

Utils

Utils

Kind: global class

• Utils
  • .capitalize(word) ⇒ String
  • .getRandomFromArray(arr) ⇒ *

Utils.capitalize(word) ⇒ String

Capitalize the first letter of a word.

Kind: static method of Utils
Returns: String - The capitalized word.

Utils.getRandomFromArray(arr) ⇒ *

Get a random element from the array

Kind: static method of Utils
Returns: * - The random element chosen.