Class CrossrefClient

Hierarchy

CrossrefClient

Index

Constructors

constructor

Methods

ping

Constructors

constructor

new CrossrefClient(mailto?, plusToken?, debug?): CrossrefClient
Parameters
- mailto: string = ""
- plusToken: string = ""
- debug: boolean = false
Returns CrossrefClient
- Defined in index.ts:19

Properties

`Protected` _debug

_debug: boolean = false

`Protected` _fetch

_fetch: (<T>(this, method, url, params?) => Promise<HttpResponse<T>>) = _fetch

Type declaration

- <T>(this, method, url, params?): Promise<HttpResponse<T>>
- Type Parameters
  - T
  Parameters
  - this: CrossrefClient
  - method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"
  - url: string
  - params: undefined | {
    [k: string]: any;
    } = undefined
  Returns Promise<HttpResponse<T>>

`Protected` _mailto

_mailto: string = ""

`Protected` _plusToken

_plusToken: string = ""

`Protected` _url

_url: string = "https://api.crossref.org"

funder

funder: ((this, id) => Promise<HttpResponse<Item<Funder>>>) = Funders.funder

Type declaration

- (this, id): Promise<HttpResponse<Item<Funder>>>
- Parameters
  - this: CrossrefClient
  - id: string
  Returns Promise<HttpResponse<Item<Funder>>>

funders

funders: ((this, query, location?, rows?, offset?) => Promise<HttpResponse<Items<Funders>>>) = Funders.funders

Type declaration

- (this, query, location?, rows?, offset?): Promise<HttpResponse<Items<Funders>>>
- Parameters
  - this: CrossrefClient
  - query: string
  - location: string = ""
  - rows: number = 20
  - offset: number = 0
  Returns Promise<HttpResponse<Items<Funders>>>

fundersWorks

fundersWorks: ((this, id, query?) => Promise<HttpResponse<Items<Work>>>) = Funders.fundersWorks

Type declaration

- (this, id, query?): Promise<HttpResponse<Items<Work>>>
- Parameters
  - this: CrossrefClient
  - id: string
  - query: undefined | QueryWorksParams = undefined
  Returns Promise<HttpResponse<Items<Work>>>

journal

journal: ((this, issn) => Promise<HttpResponse<Item<Journal>>>) = Journals.journal

Type declaration

- (this, issn): Promise<HttpResponse<Item<Journal>>>
- Parameters
  - this: CrossrefClient
  - issn: string
  Returns Promise<HttpResponse<Item<Journal>>>

journalWorks

journalWorks: ((this, issn, query?) => Promise<HttpResponse<Items<Work>>>) = Journals.journalWorks

Type declaration

- (this, issn, query?): Promise<HttpResponse<Items<Work>>>
- Parameters
  - this: CrossrefClient
  - issn: string
  - query: undefined | QueryWorksParams = undefined
  Returns Promise<HttpResponse<Items<Work>>>

journals

journals: ((this, query, rows?, offset?) => Promise<HttpResponse<Items<Journal>>>) = Journals.journals

Type declaration

- (this, query, rows?, offset?): Promise<HttpResponse<Items<Journal>>>
- Parameters
  - this: CrossrefClient
  - query: string
  - rows: number = 20
  - offset: number = 0
  Returns Promise<HttpResponse<Items<Journal>>>

licenses

licenses: ((this, query, rows?, offset?) => Promise<HttpResponse<Items<LicenseSearchResult>>>) = Licenses.licenses

Type declaration

- (this, query, rows?, offset?): Promise<HttpResponse<Items<LicenseSearchResult>>>
- Parameters
  - this: CrossrefClient
  - query: string
  - rows: number = 20
  - offset: number = 0
  Returns Promise<HttpResponse<Items<LicenseSearchResult>>>

member

member: ((this, id) => Promise<HttpResponse<Item<Member>>>) = Members.member

Type declaration

- (this, id): Promise<HttpResponse<Item<Member>>>
- Parameters
  - this: CrossrefClient
  - id: string
  Returns Promise<HttpResponse<Item<Member>>>

memberWorks

memberWorks: ((this, id, query?) => Promise<HttpResponse<Items<Work>>>) = Members.memberWorks

Type declaration

- (this, id, query?): Promise<HttpResponse<Items<Work>>>
- Parameters
  - this: CrossrefClient
  - id: string
  - query: undefined | QueryWorksParams = undefined
  Returns Promise<HttpResponse<Items<Work>>>

members

members: ((this, query) => Promise<HttpResponse<Items<Member>>>) = Members.members

Type declaration

- (this, query): Promise<HttpResponse<Items<Member>>>
- Parameters
  - this: CrossrefClient
  - query: string
  Returns Promise<HttpResponse<Items<Member>>>

prefix

prefix: ((this, prefix) => Promise<HttpResponse<Item<Prefix>>>) = Prefixes.prefix

Type declaration

- (this, prefix): Promise<HttpResponse<Item<Prefix>>>
- Parameters
  - this: CrossrefClient
  - prefix: string
  Returns Promise<HttpResponse<Item<Prefix>>>

prefixWorks

prefixWorks: ((this, prefix, query?) => Promise<HttpResponse<Items<Work>>>) = Prefixes.prefixWorks

Type declaration

- (this, prefix, query?): Promise<HttpResponse<Items<Work>>>
- Parameters
  - this: CrossrefClient
  - prefix: string
  - query: undefined | QueryWorksParams = undefined
  Returns Promise<HttpResponse<Items<Work>>>

type

type: ((this, id) => Promise<HttpResponse<Item<Type>>>) = Types.type

Type declaration

- (this, id): Promise<HttpResponse<Item<Type>>>
- Parameters
  - this: CrossrefClient
  - id: string
  Returns Promise<HttpResponse<Item<Type>>>

typeWorks

typeWorks: ((this, id, query?) => Promise<HttpResponse<Items<Work>>>) = Types.typeWorks

Type declaration

- (this, id, query?): Promise<HttpResponse<Items<Work>>>
- Parameters
  - this: CrossrefClient
  - id: string
  - query: undefined | QueryWorksParams = undefined
  Returns Promise<HttpResponse<Items<Work>>>

types

types: ((this, query, rows?, offset?) => Promise<HttpResponse<Items<Type>>>) = Types.types

Type declaration

- (this, query, rows?, offset?): Promise<HttpResponse<Items<Type>>>
- Parameters
  - this: CrossrefClient
  - query: string
  - rows: number = 20
  - offset: number = 0
  Returns Promise<HttpResponse<Items<Type>>>

work

work: ((this, doi) => Promise<HttpResponse<Item<Work>>>) = Works.work

Type declaration

- (this, doi): Promise<HttpResponse<Item<Work>>>
- Parameters
  - this: CrossrefClient
  - doi: string
  Returns Promise<HttpResponse<Item<Work>>>

works

works: ((this, query?) => Promise<HttpResponse<Items<Work>>>) = Works.works

Type declaration

- (this, query?): Promise<HttpResponse<Items<Work>>>
- Parameters
  - this: CrossrefClient
  - query: undefined | QueryWorksParams = undefined
  Returns Promise<HttpResponse<Items<Work>>>

worksAgency

worksAgency: ((this, doi) => Promise<HttpResponse<Items<Agency>>>) = Works.worksAgency

Type declaration

- (this, doi): Promise<HttpResponse<Items<Agency>>>
- Parameters
  - this: CrossrefClient
  - doi: string
  Returns Promise<HttpResponse<Items<Agency>>>

Methods

ping

ping(): string
Returns string
- Defined in index.ts:29

Class CrossrefClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

mailto: string = ""

plusToken: string = ""

debug: boolean = false

Returns CrossrefClient

Properties

Protected _debug

Protected _fetch

Type declaration

Type Parameters

T

Parameters

this: CrossrefClient

method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"

url: string

params: undefined | { [k: string]: any; } = undefined

Returns Promise<HttpResponse<T>>

Protected _mailto

Protected _plusToken

Protected _url

funder

Type declaration

Parameters

this: CrossrefClient

id: string

Returns Promise<HttpResponse<Item<Funder>>>

funders

Type declaration

Parameters

this: CrossrefClient

query: string

location: string = ""

rows: number = 20

offset: number = 0

Returns Promise<HttpResponse<Items<Funders>>>

fundersWorks

Type declaration

Parameters

this: CrossrefClient

id: string

query: undefined | QueryWorksParams = undefined

Returns Promise<HttpResponse<Items<Work>>>

journal

Type declaration

Parameters

this: CrossrefClient

issn: string

Returns Promise<HttpResponse<Item<Journal>>>

journalWorks

Type declaration

Parameters

this: CrossrefClient

issn: string

query: undefined | QueryWorksParams = undefined

Returns Promise<HttpResponse<Items<Work>>>

journals

Type declaration

Parameters

this: CrossrefClient

query: string

rows: number = 20

offset: number = 0

Returns Promise<HttpResponse<Items<Journal>>>

licenses

Type declaration

Parameters

this: CrossrefClient

query: string

rows: number = 20

offset: number = 0

Returns Promise<HttpResponse<Items<LicenseSearchResult>>>

member

`Protected` _debug

`Protected` _fetch

params: undefined | {
[k: string]: any;
} = undefined

`Protected` _mailto

`Protected` _plusToken

`Protected` _url