Github additional opportunities

Description

This is simple to use NPM package for Node.js, which give you some more possibilities for work with GitHub

Docs

Installation:

npm i github-pulse

Building:

npm run build

getPinned

Async function

Returns full information only about pinned user's repositories in array

First example:

const { getPinned } = require("github-pulse");

async function foo(username) {
  const pinned = await getPinned(username);
  console.log(pinned);
};

foo("Pesochenski"); // [...]

Second example:

const { getPinned } = require("github-pulse");

getPinned("Pesochenski")
  .then((pinned) => console.log(pinned)); // [...]

getRepoStructureCustom

Async function

Returns a tree, where each file or folder is an object named chunk

First example:

const { getRepoStructureCustom } = require("github-pulse");

// returns an object
async function bar(username, reponame) {
  return await getRepoStructureCustom(username, reponame);
};

// { id: 0, parentId: null, type: "REPOSITRORY", ... }
console.log(bar("Pesochenski", "Image_collection"));

Second example:

const { getRepoStructureCustom } = require("github-pulse");

getRepoStructureCustom("Pesochenski", "Image_collection")
  .then((tree) => {
    // { id: 0, parentId: null, type: "REPOSITRORY", ... }
    console.log(tree);
    
    // [{ id: 12345, parentId: 0, type: "DIR", ... }, ...]
    console.log(tree.inner.folders)

  // [{ id: 12345, parentId: 0, type: "FILE", ... }, ...]
  console.log(tree.inner.files)
  });

Chunk:

interface chunk {
  id: number; // unique
  parentId: number | null; // null if type = "REPOSITORY"
  type: string; // "REPOSITORY" | "FILE" | "DIR"
  name: string; 
  inner: {
    files: chunk[]; // empty if type = "FILE"
    folders: chunk[]; // empty if type = "FILE"
  };
  _actualLink: string[];
  _folderLinks: string[]; // empty if type = "FILE"
}

getRepoStructureLight

Async function

Similar with "getRepoStructureCustom", but a bit another response structure

Example:

const { getRepoStructureLight } = require("github-pulse");

// returns an array of chunks
async function bar(username, reponame) {
  return await getRepoStructureLight(username, reponame);
};

// [{ name: exampleName, path: https://github.com/path, ... }, ...]
console.log(bar("octocat", "linguist"));

Chunk:

interface chunk {
  name: string;
  path: string;
  sha: string;
  size: number;
  url: string;
  html_url: string;
  git_url: string;
  download_url: string;
  type: string; // "FILE" | "DIR"
  _links: {
    self: string;
    git: string;
    html: string;
  };
  child_arr: chunk[]; // empty if type = "FILE"
}

License

This package is under the MIT license.

Support

Pull requests or issues are welcomed