Class Spine

constructor

• new Spine(): Spine

  Returns Spine

baseUrl

epubcfi

hooks

items

length

loaded

manifest

spineByHref

spineById

spineItems

spineNodeIndex

destroy

• destroy(): void

  Returns void

each

• each(fn: (section: Section, index: number, array: Section[]) => void): void

  Loop over the Sections in the Spine

  Parameters

  • fn: (section: Section, index: number, array: Section[]) => void

  Returns void

  forEach

first

• first(): Section | undefined

  Find the first Section in the Spine

  Returns Section | undefined

  first section

get

• get(target?: string | number): Section | null

  Get an item from the spine

  Parameters

  • Optionaltarget: string | number

  Returns Section | null

  section

  Example

  spine.get();
  Copy

  Example

  spine.get(1);
  Copy

  Example

  spine.get("chap1.html");
  Copy

  Example

  spine.get("#id1234");
  Copy

last

• last(): Section | undefined

  Find the last Section in the Spine

  Returns Section | undefined

  last section

unpack

• unpack(
      _package: Packaging & { basePath?: string; baseUrl?: string },
      resolver: (href: string, absolute?: boolean) => string,
      canonical: (href: string) => string,
  ): void

  Unpack items from a opf into spine items

  Parameters

  • _package: Packaging & { basePath?: string; baseUrl?: string }
  • resolver: (href: string, absolute?: boolean) => string

    URL resolver

  • canonical: (href: string) => string

    Resolve canonical url

  Returns void