Repository files navigation

This client was generated usingOpenAPI Generator from theIPFS Pinning Service API spec.

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

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:

import{Configuration,RemotePinningServiceClient,Status}from'@ipfs-shipyard/pinning-service-client'importtype{PinsGetRequest,PinResults}from'@ipfs-shipyard/pinning-service-client'constconfig=newConfiguration({  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 NodeJS fetch by default.})constclient=newRemotePinningServiceClient(config)(async()=>{// Get 10 failed PinsconstpinsGetOptions:PinsGetRequest={limit:10,status:[Status.Failed]}const{count, results}:PinResults=awaitclient.pinsGet(pinsGetOptions)console.log(count,results)})()

To build and compile the typescript sources to javascript use:

npm installnpm run build

To update the client, you need tonpm run gen npm script. This will fetch the latest version of the OpenAPI spec and generate the client. However, openapi-generator-cli does not currently generate the client code with proper import syntax. So you must modify the imports ingenerated/fetch/** directly, or justgit checkout -p to remove the invalid import path changes.

It also usesSets for all collection types though it cannot serialize or deserialize these types to/from JSON. They must be manually changed to beArrays.

If you need to modify the generated code's import paths, you will have to runnpm run postgen manually.

SeeCONTRIBUTING.md.

First build the package then runnpm publish

Licensed under either of

• Apache 2.0, (LICENSE-APACHE /http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT /http://opensource.org/licenses/MIT)

Unless you explicitly state otherwise, any contribution intentionally submittedfor inclusion in the work by you, as defined in the Apache-2.0 license, shallbe dual licensed as above, without any additional terms or conditions.