Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "lib/transform/updateTitle"

Index

Variables

Const updateTitle

updateTitle: updateTitleTransform = updateTitleTransform

Deprecated: use updateTitleTransform for the transform, or updatePageTitle within a transform of your own.

Functions

failedTransformResult

  • failedTransformResult(p: Project, error: Error): TransformResult

updatePageTitle

  • updatePageTitle(project: Project, path: string, newTitle: string): Promise<void>
  • Update the title of a markdown file within a project. If the file does not exist or cannot be parsed as markdown or does not currently have a title, returns a rejected promise.

    Parameters

    • project: Project
    • path: string
    • newTitle: string

    Returns Promise<void>

updateTitleTransform

  • updateTitleTransform(path: string, newTitle: string): CodeTransform
  • Get a code transform that updates the title of a markdown file to a fixed string

    Parameters

    • path: string
    • newTitle: string

    Returns CodeTransform

Generated using TypeDoc