Class ContentModel

constructor

• new ContentModel(owner: string, repository: string): ContentModel

  Parameters

  • owner: string
  • repository: string

  Returns ContentModel

client

owner

repository

getOne

• getOne(path: string): Promise<Content>

  Get repository content at a specific path

  Parameters

  • path: string

  Returns Promise<Content>

  See

  https://docs.github.com/en/rest/repos/contents#get-repository-content

openStream

• openStream(
      __namedParameters: Filter<Content>,
  ): AsyncGenerator<Content, void, unknown>

  Parameters

  • __namedParameters: Filter<Content>

  Returns AsyncGenerator<Content, void, unknown>

traverseChildren

• traverseChildren(
      parentPath?: string,
      onCount?: (total: number) => any,
  ): AsyncGenerator<Content>

  Get direct children of a directory

  Parameters

  • parentPath: string = ''
  • onCount: (total: number) => any = ...

  Returns AsyncGenerator<Content>

traverseTree

• traverseTree(
      parentContent?: Content,
      onCount?: (total: number) => any,
  ): AsyncGenerator<Content>

  Recursively traverse the entire file tree

  Parameters

  • OptionalparentContent: Content
  • OptionalonCount: (total: number) => any

  Returns AsyncGenerator<Content>

updateOne

• updateOne(
      __namedParameters: Partial<NewData<Content>>,
      path: string,
      message?: string,
  ): Promise<Content>

  Parameters

  • __namedParameters: Partial<NewData<Content>>
  • path: string
  • message: string = ...

  Returns Promise<Content>