@wral/sdk-scraper

sdk-scraper

The sdk-scraper is a JavaScript SDK (Software Development Kit) designed to interact with an API that generates and validates JWTs.

Installation

You can install sdk-scraper package with npm

npm install @wral/sdk-scraper

Usage

Import it into your JavaScript or TypeScript project:

import { createClient } from '@wral/sdk-scraper';

Then, you can create a client instance with your configuration:

const config = {
  baseUrl: 'YOUR_BASE_URL', // Base URL of your API
  apiKey: 'YOUR_API_KEY', // Your API key
};

const client = createClient(config);

After creating the client instance, you can use its methods to interact with the API. Here are some examples:

// Scrape example.com for metadata
let metadata = await client.metadata({ uri: 'https://www.example.com/' });

API

createClient(config)

Creates a new client instance with the provided configuration.

• config: An object containing API configuration parameters:
  • baseUrl: The base URL of the API.
  • apiKey: Your API key.

Returns a client instance with methods for interacting with the API.

Methods

• api: (path, options = {}): fetch wrapper for the API.
• metadata({ uri, agent } = {}): scrape metadata from an URI, with optional user agent