Skip to content

Latest commit

 

History

History
95 lines (80 loc) · 4.63 KB

README.md

File metadata and controls

95 lines (80 loc) · 4.63 KB

Behance-node

NPM Version Strict TypeScript Checked License

An asynchronous module for scrapping Behance using JavaScript.

Install

npm i behance-node

Usage

const Behance = require('behance-node');

Documentation

User data

Return data about user.

  • Method:

    • user(username: string, detailed?: boolean)
  • Parameters:

    Name Type Info
    username string Desired username
    detailed boolean Return more detail about user or not
  • Example:

    • Get detailed data about this user https://www.behance.net/moesalah.
      Behance.user('moesalah', true)
          .then( result => console.log(result) )
          .catch( error => console.log(error) );

Project data

Return data about project.

  • Method:

    • project(path: string)
  • Parameter:

    Name Type Info
    path string Desired project path, must contain project id and name
  • Example:

    • Get data about this project https://www.behance.net/gallery/77156181/Amazon-Rebranding-UI-Concept.
      Behance.project('77156181/Amazon-Rebranding-UI-Concept')
          .then( result => console.log(result) )
          .catch( error => console.log(error) );

Random project

Get a random project data using sort.

  • Method:

    • randomProject( sort?: 'recommended' | 'curated' | 'most_appreciated' | 'most_viewed' | 'most_commented' | 'most_recent', time?: 'today' | 'this_week' | 'this_month' | 'all_time' )
  • Parameters:

    Name Type Info
    sort recommended, curated, most_appreciated, most_viewed, most_commented, most_recent Only most_appreciated, most_viewed, most_commented can be used with time parameter
    time today, this_week, this_month, all_time Sort result by date
  • Examples:

    • Get a random project from most viewed this week.
      Behance.randomProject('most_viewed', 'this_week')
          .then( result => console.log(result) )
          .catch( error => console.log(error) );
    • Get a random curated project.
      Behance.randomProject('curated')
          .then( result => console.log(result) )
          .catch( error => console.log(error) );

Links

License

Apache License 2.0