Git Product home page Git Product logo

samkemxcrossref-client's Introduction

Crossref API Typescript Client

The client has been developed as part of a research programme investigating agent-based manufacturing systems. The client has been used in our systematic literature reviews. It is isomorphic capable of running on server (Node.js) and client-side (Browser) applications.

Using crossref-client

To install the package, use the following code. I am aiming to put it onto npm soon.

pnpm install @jamesgopsill/crossref-client

You can then use it in your code like so (see the examples folder for more implementations):

Typescript

import { CrossrefClient, QueryWorksParams } from "@jamesgopsill/crossref-client"

const client = new CrossrefClient()

const search: QueryWorksParams = {
	queryAuthor: "Richard Feynman",
}
const r = await client.works(search)
if (r.ok && r.status == 200) console.log(r.content)

Javascript (ESM)

import { CrossrefClient } from "@jamesgopsill/crossref-client"

const client = new CrossrefClient()

const search = {
	queryAuthor: "Richard Feynman",
}
const r = await client.works(search)
if (r.ok && r.status == 200) console.log(r.content)

Javascript (CJS)

const { CrossrefClient } = require("@jamesgopsill/crossref-client")

const client = new CrossrefClient()

const search = {
	queryAuthor: "Richard Feynman",
}
client.works(search).then((r) => {
	if (r.ok && r.status == 200) console.log(r.content)
})

Documentation

The docs have been produced using TypeDoc and can be accessed here. More details on the API can be found at Crossref API.

Contributing

We would love to have additional contributors to the project to help us maintain and add functionality to the project.

Support the Project

The project has been supported by the EPSRC-funded Brokering Additive Manufacturing project (EP/V05113X/1). More details on the project can be found at the Design Manufacturing Futures Lab website.

If you end up using the client a lot, please consider sponsoring the project to support the continued development and maintanence of the client.

samkemxcrossref-client's People

Contributors

jamesgopsill avatar

Stargazers

Sam Ken  (SAMkenXCC) avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.