❤
npm
Sign UpSign In

angular-wikipedia-api-factory

0.2.4 • Public • Published

angular-wikipedia-api-factory is an angularjs module with a wikipedia api factory.

npm version Bower version

Author: Jonathan Hornung (JohnnyTheTank)

Usage

  1. Install via either bower, npm or downloaded files:

    1. bower install --save angular-wikipedia-api-factory
    2. npm install --save angular-wikipedia-api-factory
    3. download angular-wikipedia-api-factory.zip

  2. Include dependencies in your HTML.

    1. When using bower:
    <script src="bower_components/angular-wikipedia-api-factory/dist/angular-wikipedia-api-factory.min.js"></script>
    1. When using npm:
    <script src="node_modules/angular-wikipedia-api-factory/dist/angular-wikipedia-api-factory.min.js"></script>
    1. when using downloaded files
    <script src="angular-wikipedia-api-factory.min.js"></script>

  3. Add jtt_wikipedia to your application's module dependencies

    angular.module('app', ['jtt_wikipedia']);

  4. Use the factory wikipediaFactory

    angular.module('app')
        .controller('appController', function($scope, wikipediaFactory){
        
            wikipediaFactory.getArticle({
                term: 'Oktoberfest'
            }).then(function (_data) {
                //on success
            });
            
        });

factory methods

searchArticles

wikipediaFactory.searchArticles({
    term: '<TERM>', // Searchterm
    lang: '<LANGUAGE>', // (optional) default: 'en'
    gsrlimit: '<GS_LIMIT>', // (optional) default: 10. valid values: 0-500
    pithumbsize: '<PAGE_IMAGES_THUMBNAIL_SIZE>', // (optional) default: 400
    pilimit: '<PAGE_IMAGES_LIMIT>', // (optional) 'max': images for all articles, otherwise only for the first
    exlimit: '<EX_LIMIT>', // (optional) 'max': extracts for all articles, otherwise only for the first
    exintro: '<EX_INTRO>', // (optional) '1': if we just want the intro, otherwise it shows all sections
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});
wikipediaFactory.searchArticlesByTitle({
    term: '<TERM>', // Searchterm
    lang: '<LANGUAGE>', // (optional) default: 'en'
    gsrlimit: '<GS_LIMIT>', // (optional) default: 10. valid values: 0-500
    pithumbsize: '<PAGE_IMAGES_THUMBNAIL_SIZE>', // (optional) default: 400
    pilimit: '<PAGE_IMAGES_LIMIT>', // (optional) 'max': images for all articles, otherwise only for the first
    exlimit: '<EX_LIMIT>', // (optional) 'max': extracts for all articles, otherwise only for the first
    exintro: '<EX_INTRO>', // (optional) '1': if we just want the intro, otherwise it shows all sections
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});

getArticle

wikipediaFactory.getArticle({
    term: '<TERM>', // Searchterm
    lang: '<LANGUAGE>', // (optional) default: 'en'
    pithumbsize: '<PAGE_IMAGE_THUMBNAIL_SIZE>', // (optional) default: '400'
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});

Wikipedia JSONP API

More angular-api-factories

bandsintown - dailymotion - facebook - flickr - footballdata - github - openweathermap - tumblr - vimeo - wikipedia - youtube

License

MIT

Readme

Keywords

Package Sidebar

Install

npm i angular-wikipedia-api-factory

Repository

github.com/JohnnyTheTank/angular-wikipedia-api-factory

Homepage

github.com/JohnnyTheTank/angular-wikipedia-api-factory#readme

Weekly Downloads

4

Version

0.2.4

License

MIT

Last publish

Collaborators

  • johnnythetank
Try on RunKit
Report malware