ghostdevv/sourcebin

Fast and simple package to get and create bins from https://sourceb.in/

Sourcebin

Fast and simple package to get and create bins from sourcebin

Requirements

NodeJS >= 14.x

Install

npm install sourcebin

Docs

This README is the best place to learn how to use this package, you can also take a look at our API docs

Setup

// Import individual methods
import { create, get, url } from 'sourcebin';

// Import all methods
import * as sourcebin from 'sourcebin';

// Use required
const { create, get, url } = require('sourcebin');

Get a bin

get(options)

const bin = await get({
    key: 'qXO2NVhRc6'
});

Options

Option	Description	Default	Required
key	The key to get	n/a	✅
fetchContent	Should the bin content be fetched	true	❌

Create a bin

create(options)

const bin = await create(
    {
        title: 'bin name',
        description: 'test bin',
        files: [
            {
                content: 'Hello World',
                language: 'text',
            },
        ],
    },
);

Options

Option	Description	Required
title	Title of the bin	❌
description	Description of the bin	❌
files	Bin files - see below	✅

File Options

Option	Description	Default	Required
content	Contents of the file	n/a	✅
language	What language should the file be	text	❌

Url Helper

If you want to get information about a bin try the url function.

const urlData = url('iQznILdZRP');

// or

const urlData = url('https://sourceb.in/iQznILdZRP');

This returns an object that looks like:

{
  key: 'iQznILdZRP',
  url: 'https://sourceb.in/iQznILdZRP',
  short: 'http://srcb.in/iQznILdZRP'
}

FAQ

• Multiple files in one bin

  This is not currently possible with this wrapper as sourcebin doesn't have a token system for authentication, only pro users are able to have multiple files in one bin. This may come in the future

• Migrate from v4 to v5

  v5 is a overhaull of sourcebin so we changed some apis.

  Get a bin

  Instead of passing the key then options it's now one object.

  - const bin = await get('qXO2NVhRc6');
  + const bin = await get({ key: 'qXO2NVhRc6' });
  
  - const bin = await get('qXO2NVhRc6', { fetchContent: false });
  + const bin = await get({ key: 'qXO2NVhRc6', fetchContent: false });

  Create a bin

  We also unified the options for this function:

  - const bin = await create(
  -    [
  -        {
  -            content: 'Hello World',
  -            language: 'text',
  -        },
  -    ],
  -    {
  -        title: 'bin name',
  -        description: 'test bin',
  -    },
  - );
  
  + const bin = await create(
  +   {
  +       title: 'bin name',
  +       description: 'test bin',
  +       files: [
  +           {
  +               content: 'Hello World',
  +               language: 'text',
  +           },
  +       ],
  +   }
  +  );

Support

• Join the discord
• Create a issue on the github

sourcebin's Issues

Detect an error if bin size exceeds the size limit

Typescript Support

SyntaxError: Invalid key provided - SourceBin#shorten

Upon trying to create a bin using sourcebin#create, I receive an error that an invalid key was provided.

(node:40713) UnhandledPromiseRejectionWarning: SyntaxError: Invalid key provided - SourceBin#shorten
    at Function.shorten (/Users/<omitted>/Desktop/home/<omitted>/node_modules/sourcebin/src/sourcebin-methods.js:148:59)
    at /Users/<omitted>/Desktop/home/<omitted>/node_modules/sourcebin/src/sourcebin-methods.js:132:33
    at processTicksAndRejections (internal/process/task_queues.js:97:5)
(node:40713) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
(node:40713) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

Any solution for this?

Tests

Ability to enable debug messages

Ability to get verbose debug messages to help resolve odd issues

Switch to axios

Self explanatory, switch to axios since it's more known and preferable

ES Module support

Is there any limit of the bin to store data?

Update error handling

Able to fully catch error (remove console.error's)
Move indepth error checking (e.g. if bin creating fails, why?)

Esm named imports doesn't work

This:

import { create } from 'sourcebin';

Results in a export error