Skip to main content Link Menu Expand (external link) Document Search Copy Copied

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 creators: ReadonlyArray<
    | {
        givenName?: string
        familyName: string
        nameIdentifiers: ReadonlyArray<{ nameIdentifier: string; nameIdentifierScheme: string }>
      }
    | { name: string }
  >
  readonly dates: ReadonlyNonEmptyArray<{
    date: Instant | PartialDate
    dateType: string
  }>
  readonly descriptions: ReadonlyArray<{ description: string; descriptionType: string }>
  readonly doi: Doi
  readonly identifiers: ReadonlyArray<{ identifier: string; identifierType: string }>
  readonly publisher: string
  readonly relatedIdentifiers: ReadonlyArray<{
    relationType: string
    relatedIdentifier: string
    resourceTypeGeneral?: string
    relatedIdentifierType: string
  }>
  readonly types: {
    resourceType?: string
    resourceTypeGeneral?: string
  }
  readonly titles: ReadonlyNonEmptyArray<{ title: string }>
  readonly url: URL
}

Added in v0.1.0