https://github.com/ipfs-shipyard/js-pinning-service-http-client

An IPFS Pinning Service HTTP Client for TypeScript / Javascript
https://github.com/ipfs-shipyard/js-pinning-service-http-client

ipfs ipfs-gui

Last synced: 3 months ago
JSON representation

An IPFS Pinning Service HTTP Client for TypeScript / Javascript

• Host: GitHub
• URL: https://github.com/ipfs-shipyard/js-pinning-service-http-client
• Owner: ipfs-shipyard
• License: other
• Created: 2022-02-10T00:10:18.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-10T11:04:34.000Z (over 1 year ago)
• Last Synced: 2024-04-01T16:11:06.085Z (3 months ago)
• Topics: ipfs, ipfs-gui
• Language: TypeScript
• Homepage:
• Size: 7.48 MB
• Stars: 9
• Watchers: 9
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Lists

• awesome-stars - js-pinning-service-http-client - shipyard | 9 | (TypeScript)

README

        
## IPFS Pinning Service API Client for JS

This client was generated using [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) from the [IPFS Pinning Service API spec](https://ipfs.github.io/pinning-services-api-spec/).

You can see the commands used to generate the client in the `gen:fetch` npm script.

### Usage

```

npm install @ipfs-shipyard/pinning-service-client --save

```

This client only has a programmatic API at the moment (no CLI). You use it like so:

```ts

import { Configuration, RemotePinningServiceClient, Status } from '@ipfs-shipyard/pinning-service-client'

import type { PinsGetRequest, PinResults } from '@ipfs-shipyard/pinning-service-client'

const config = new Configuration({

  endpointUrl, // the URI for your pinning provider, e.g. `http://localhost:3000`

  accessToken, // the secret token/key given to you by your pinning provider

  // fetchApi: fetch, // You can pass your own fetchApi implementation, but we use fetch-ponyfill by default.

})

const client = new RemotePinningServiceClient(config)

(async () => {

  // Get 10 failed Pins

  const pinsGetOptions: PinsGetRequest = {

    limit: 10,

    status: new Set([Status.Failed]) // requires a set, and not an array

  }

  const {count, results}: PinResults = await client.pinsGet(pinsGetOptions)

  console.log(count, results)

})()

```

## Developing

### Building

To build and compile the typescript sources to javascript use:

```

npm install

npm run build

```

### Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

### Publishing

First build the package then run ```npm publish```

## License

Licensed under either of

 * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)

 * MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)

Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in the work by you, as defined in the Apache-2.0 license, shall

be dual licensed as above, without any additional terms or conditions.