socialsplash
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

SocialSplash

Helper package to generate your images through SocialSplash API.

Installation

npm install socialsplash

Usage

import SocialSplash from 'socialsplash'

const splash = new SocialSplash({
  apiKey: '<your-api-key>',
  apiDomain: '<your-domain>',
  urlDomain: '<your-domain>',
})

const url = splash.url('<template uuid>', {
  title: 'My title',
  description: 'Hello world'
})

const url = splash.signedUrl('<template uuid>', {
  title: 'My title',
  description: 'Hello world'
})

const buffer = splash.image('<template uuid>', {
  title: 'My title',
  description: 'Hello world'
})

const url = splash.signedImage('<template uuid>', {
  title: 'My title',
  description: 'Hello world'
})

Examples

Generating an image with a public template

import { SocialSplash } from 'socialsplash'

const splash = new SocialSplash()

Readme

Keywords

none

Package Sidebar

Install

npm i socialsplash

Weekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

26.9 kB

Total Files

13

Last publish

Collaborators

  • williamdasilva