https://github.com/cob16/circleci-typescript-axios

Autogenerated sdk for circle ci v2
https://github.com/cob16/circleci-typescript-axios

api-client circle-ci circle-ci-2 circleci javascript sdk typescript v2

Last synced: 3 months ago
JSON representation

Autogenerated sdk for circle ci v2

• Host: GitHub
• URL: https://github.com/cob16/circleci-typescript-axios
• Owner: cob16
• License: mit
• Created: 2020-04-01T22:43:30.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-06T09:35:18.000Z (4 months ago)
• Last Synced: 2024-10-07T19:09:23.620Z (3 months ago)
• Topics: api-client, circle-ci, circle-ci-2, circleci, javascript, sdk, typescript, v2
• Homepage: https://www.npmjs.com/package/circleci-typescript-axios
• Size: 121 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# circleci-typescript-axios

[![circleci-typescript-axios](https://circleci.com/gh/cob16/circleci-typescript-axios/tree/master.svg?style=svg)](https://circleci.com/gh/cob16/circleci-typescript-axios/tree/master)

Autogenerated sdk for circle ci v2

**Warning** the circle v2 api is in preview and is **currently making braking changes** see [breaking.md](https://github.com/CircleCI-Public/api-preview-docs/blob/master/docs/breaking.md)

[See the full doc here](https://cob16.github.io/circleci-typescript-axios/)

# Getting started

```bash

npm i circleci-typescript-axios --save

```

or to build form source 

```bash

git clone https://github.com/cob16/circleci-typescript-axios.git

cd circleci-typescript-axios

npm install

npm run build

```

Example Usage

```typescript

import { PreviewApiFactory, Project } from 'circleci-typescript-axios';

let client = PreviewApiFactory({

  apiKey: '',

});

client

  .getProjectBySlug('gh/cob16/circleci-lib')

  .then(resp => {

    let project: Project = resp.data;

    console.log(project.name);

    console.log(project.organization_name);

    console.log(project.slug);

    console.log(project.vcs_info);

  })

  .catch(error => {

    console.log(error);

  });

```

To see other methods [See the full doc here](https://cob16.github.io/circleci-typescript-axios/)