Have ideas to improve npm?Join in the discussion! »

    weekly-summary-typescript
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.1 • Public • Published

    Weekly Summary TypeScript

    npm version CircleCI Coverage Status Commitizen friendly semantic-release

    This package gets the last week of merged pull requests for a specific organization from GitHub.

    Installing

    npm install weekly-summary-typescript

    Usage

    Requsting pull requests

    import { fetchRecentlyClosedPullRequests } from "weekly-summary-typescript";
     
    const recentlyClosedPullRequests = await fetchRecentlyClosedPullRequests(
      {
        organization: `my-organization`
      },
      `my-github-auth-token`
    );

    Response

    Pull requests are returned as an object where the key is the repository's name and the value is an array of objects that include information about the pull request. For example:

    {
      "weekly-summary-typescript": [
        {
          "repository": {
            "name": "weekly-summary-typescript"
          },
          "title": "refactor(github): changes setup for GitHub auth token",
          "createdAt": "2019-11-02T19:14:53Z",
          "closedAt": "2019-11-03T10:58:15Z",
          "url": "https://github.com/tmr08c/weekly-summary-typescript/pull/14",
          "merged": true
        },
        {
          "repository": {
            "name": "weekly-summary-typescript"
          },
          "title": "chore: sets up commitizen",
          "createdAt": "2019-11-02T19:00:06Z",
          "closedAt": "2019-11-02T19:00:51Z",
          "url": "https://github.com/tmr08c/weekly-summary-typescript/pull/13",
          "merged": true
        }
      ]
    }

    Type definitions can be found here.

    You can also check out this project for an example of how this package is used in production.

    Install

    npm i weekly-summary-typescript

    DownloadsWeekly Downloads

    10

    Version

    1.0.1

    License

    ISC

    Unpacked Size

    24.8 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar