README.md

Microlink Function allows you to run JavaScript Serverless functions with Headless Chromium programmatic access.

Highlights

• Starts from $0/mo.
• Run Serverless Javascript functions (also locally).
• Ability to require to require any of the allowed NPM packages.
• Headless Chromium browser access in the same request cycle.
• No servers to maintain, no hidden cost or infrastructure complexity.

Contents

• How it works
• Installation
  • from NPM
  • from CDN
• Get Started
  • Input
    • NPM packages
  • Output
• Examples
• Pricing
• API
• License

How it works

Every time you call a Microlink Function, the code function will be compiled and executed remotely in a safe V8 sandbox.

It's pretty similar to AWS Lambda, but rather than bundle your code, all the code will be executed remotely, giving the result of the execution back to you.

Microlink Function can be invoked in frontend or backend side. There is nothing to deploy or hidden infrastructure cost associated.

Installation

from NPM

It's available as npm package:

$ npm install @microlink/function --save

from CDN

Load directly in the browser from your favorite CDN:

<script src="https://cdn.jsdelivr.net/npm/@microlink/function/dist/microlink-function.min.js"></script>

Get Started

Input

Let say you have a JavaScript like this:

const ping = ({ statusCode, response }) =>
  statusCode ? response.status() : response.statusText()

To run the previous code as Microlink Function, all you need to do is wrap the function with the microlink decorator:

const microlink = require('@microlink/function')

const ping = microlink(({ response }) =>
  statusCode ? response.status() : response.statusText()
)

Then, just call the function as you would normally:

const result = await ping('https://example.com', { statusCode: true })

console.log(result)

// {
//   isFullfilled: true,
//   isRejected: false,
//   value: 200
// }

When a function is wrapped by Microlink Function the function execution is done remotely, giving back the result.

Any Microlink Function will receive the following parameters:

• html: When meta is enabled, the HTML markup of the website is provided.
• page: The puppeteer#page instance to interact with the headless browser.
• response: The puppeteer#response as result of the implicit page.goto.

NPM packages

Additionally, you can require a allowed list of common NPM packages inside your code blocks:

const microlink = require('@microlink/function')

const ping = microlink(({ statusCode, response }) => {
  const { result } = require('lodash')
  return result(response, statusCode ? 'status' : 'statusText')
})

The list of allowed NPM packages are:

• path
• url
• @aws-sdk/client-s3
• @metascraper
• @mozilla/readability
• async
• cheerio
• extract-email-address
• got
• ioredis
• jsdom
• lodash
• metascraper
• p-reflect
• p-retry
• p-timeout

Do you miss any NPM modules there? open a new issue and we make it available.

Output

When a Microlink Function is executed, the result response object has the following interface:

• isFulfilled
• isRejected
• value or reason, depending on whether the promise fulfilled or rejected.

Testing

Check @microlink/local for executing your Microlink Functions locally.

Examples

Check examples.

Pricing

Microlink Function has been designed to be cheap and affordable.

The first 50 uncached requests of every day are free. If you need more, you should to buy a pro plan.

For authenticating your requests, you should to provide your API key:

const microlink = require('@microlink/function')

const code = ({ statusCode, response }) => {
  const { result } = require('lodash')
  return result(response, statusCode ? 'status' : 'statusText')
}

const ping = microlink(code, { apiKey: process.env.MICROLINK_API_KEY })

API

microlink(fn, [mqlOpts], [gotoOpts])

fn

Required
Type: function

The function that be executed inside Microlink API browser.

mqlOpts

Type: object

The function that be executed inside Microlink API browser.

Any option passed here will bypass to mql.

gotoOpts

Type: object

Any option passed here will bypass to browserless#goto.

License

microlink-function © Microlink, released under the MIT License.
Authored and maintained by Kiko Beats with help from contributors.

microlink.io · GitHub @MicrolinkHQ · X @microlinkhq