@lifeomic/facebook-test-users

Utilities for working with Facebook test users

Stats

StarsIssuesVersionUpdatedCreatedSize
@lifeomic/facebook-test-users
002.1.09 months ago4 years agoMinified + gzip package size for @lifeomic/facebook-test-users in KB

Readme

facebook-test-users

Utilities for working with Facebook test users, this package uses v10.0 of the Facebook graph-api. link

Coverage Status Greenkeeper badge

Usage

Install the package as a dependency.

$ npm install --save @lifeomic/facebook-test-users

Create a client instance.

const testUsers = require('@lifeomic/facebook-test-users');
. . .
const client = await testUsers.createClient({ appId, appSecret });

async testUsers.createClient({ appId, appSecret })

Create a new client instance.

  • appId — the Facebook application's client ID
  • appSecret - the Facebook application's client secret

async client.createTestUser(options)

Create a new test user. Returns a description of the user.

  • optionsoptional an object specifying the fields to apply when publishing the user

References:

async client.deleteTestUser({ id })

Delete a test user.

  • id — the uid of the user to delete

References:

async client.findTestUser(fields)

Find a test user that matches the specified fields. Returns a description of the matching user augmented with the matched fields or null if no users matched the specified fields.

  • fields — An object describing the fields that the test user must match. Only fields from the user node can be matched.

async client.getTestUser({ id, includeFields })

Fetches the user node for the user with the specified ID. Returns the user node with the specified fields.

  • id — the ID of the user to retrieve
  • includeFields optional An array specifying the fields to include. Only fields from the user node may be specified.

References:

async client.listTestUsers({ includeFields })

Get a list of all test users associated with the app. Returns a list of user descriptions augmented with any additional requested fields.

  • includeFields optional An array specifying the fields to include. Only fields from the user node may be specified.

References:

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.