wiktionary-sound-scraper
v1.0.5
Published
Downloads and converts sounds from wiktionary.org
Downloads
27
Maintainers
Readme
Wiktionary sound scraper
npm module to download and convert sounds from wiktionary.org.
Helpful when you have a long list of words and you want to know how they sound.
How to use
Install the module
$ npm install wiktionary-sound-scraper --save
Conversion
ffmpeg is necessary to convert files. Files on wiktionary are in .ogg or .ogv
Play with it
var scraper = require('wiktionary-sound-scraper')
var folder = __dirname + '/downloads/'
var opts = {location: folder, lang: 'fr', basename: 'shoe-sound', ext: '.mp3'}
scraper.scrap('shoe', opts, function (err, vinyl) {
if (err) console.log('Didn\'t work: ' + err)
else console.log('Here comes the file: ' + vinyl.path)
})
Examples
There are some in the examples
folder, including one how to scrap words from a .csv
file.
Doc
scrap(word, options, callback)
word
- Type:
String
- Mandatory
- Word to look for.
options
- Type:
Object
- Mandatory but can be an empty object (ie.:
{}
)
options.folder
- Type:
Object
- Optional
- Default:
__dirname
- Folder to download the file to, will be created if necessary.
options.lang
- Type:
String
- Optional
- Default:
'en'
- The wiktionary to search in (eg.:
'de'
for de.wiktionary.org).
options.basename
- Type:
String
- Optional
- Default:
null
- Name of the final file, without extension.
options.ext
- Type:
String
- Optional
- Default:
null
- Extension, eg.
'.mp3'
.
callback
- Type:
Function
- Mandatory
- Function called once the operation has been performed.
- Takes two arguments:
err
: if an error occuredvinyl
: vinyl file built at the end
Feedbacks, please!
Pull requests and issues are here for that!