index overview

Added in v0.1.0


Table of contents


codecs

WorkC

Signature

export declare const WorkC: C.Codec<string, string, Work>

Added in v0.1.0

constructors

getWork

Signature

export declare const getWork: (doi: Doi) => ReaderTaskEither<FetchEnv, unknown, Work>

Added in v0.1.0

model

PartialDate (type alias)

Signature

export type PartialDate = number | PlainYearMonth | PlainDate

Added in v0.1.1

Work (interface)

Signature

export interface Work {
  readonly abstract?: string
  readonly author: ReadonlyArray<
    | {
        family: string
        given?: string
        ORCID?: Orcid
        prefix?: string
        suffix?: string
      }
    | {
        name: string
      }
  >
  readonly created: PartialDate
  readonly description?: string
  readonly DOI: Doi
  readonly 'group-title'?: string
  readonly institution: ReadonlyArray<{ name: string }>
  readonly language?: LanguageCode
  readonly license: ReadonlyArray<{ start: PartialDate; URL: URL }>
  readonly published?: PartialDate
  readonly publisher: string
  readonly resource: { primary: { URL: URL } }
  readonly subtype?: string
  readonly title: ReadonlyArray<string>
  readonly type: string
}

Added in v0.1.0