Sourceshare NPM

sourceShare

npm.io

Install

npm install sourceshare

Setup

// Import methods
import { SRCreate, SRGet } from 'sourceshare';


// Use required
const { SRCreate, SRGet } = require('sourceshare');

Creating a bin

SRCreate(method, options)

srcShare

const key = await SRCreate("srcShare", {
  title: "srcShare",
  description: "srcShare Bin",
  language: "javascript",
  files: [
    { name: "file1", content: "content" },
    { name: "file2", content: "content2" },
  ],
});

sourceBin

const key = await SRCreate("sourceBin", {
  title: "sourceBin",
  description: "sourceBin Bin",
  files: [{ name: "file", content: "content", languageId: "javascript" }],
});

Options

Option	Description	Default	Required	srcShare	sourceBin
`title`	The title of the Bin	`undefined`	❌	✅	✅
`description`	The description of the Bin	`undefined`	❌	✅	✅
`language`	The language of the entire bin	`javascript`	❌	✅	❌
`file`	The files in the bin - options below	n/a	✅	✅	✅

File Options

Option	Description	Default	Required	srcShare	sourceBin
`name`	Name of the file	undefined	❌	✅	✅
`content`	Contents of the file	n/a	✅	✅	✅
`language`	What language should the file be	`text`	❌	❌	✅

Getting a bin

SRGet(method, options)

srcShare

const bin = await SRGet("srcShare", { key: "6413e41aff7ba5ec61153e4c" });

{
  "_id": "6413e41aff7ba5ec61153e4c",
  "tabs": [
    { "name": "file1", "content": "context1", "_id": "6413e41aff7ba5ec61153e4d" },
    {
      "name": "file2",
      "content": "context2",
      "_id": "6413e41aff7ba5ec61153e4e"
    }
  ],
  "language": "javascript",
  "title": "srcShare",
  "description": "srcShare Bin",
  "expires": "2023-03-24T03:52:58.665Z",
  "__v": 0
}

sourceBin

const bin = await SRGet("sourceBin", { key: "2wVSfa7tuF"})

{
  "hits": 1,
  "_id": "6413e417980ab20018e4b069",
  "key": "2wVSfa7tuF",
  "title": "sourceBin",
  "description": "sourceBin Bin",
  "files": [ { "name": "file", "languageId": 183, "content": "context" } ],
  "created": "2023-03-17T03:52:55.690Z"
}