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

core overview

Added in v0.0.1


Table of contents


utils

AppEff (interface)

App effect

Signature

export interface AppEff<A> extends RTE.ReaderTaskEither<Context, string, A> {}

Added in v0.0.1

Capabilities (interface)

Signature

export interface Capabilities extends MonadFileSystem, MonadLog {}

Added in v0.0.1

Context (interface)

Signature

export interface Context {
  readonly C: Capabilities
}

Added in v0.0.1

Eff (interface)

capabilities

Signature

export interface Eff<A> extends TE.TaskEither<string, A> {}

Added in v0.0.1

MonadFileSystem (interface)

Signature

export interface MonadFileSystem {
  readonly getFilenames: (pattern: string) => Eff<string[]>
  readonly readFile: (path: string) => Eff<string>
  readonly writeFile: (path: string, content: string) => Eff<void>
  readonly rmFile: (path: string) => Eff<void>
  readonly existsFile: (path: string) => Eff<boolean>
  readonly isFile: (path: string) => Eff<boolean>
  readonly isDirectory: (path: string) => Eff<boolean>
}

Added in v0.0.1

MonadLog (interface)

Signature

export interface MonadLog {
  readonly info: (message: string) => Eff<void>
  readonly log: (message: string) => Eff<void>
  readonly debug: (message: string) => Eff<void>
}

Added in v0.0.1

main

Main

Signature

export declare const main: AppEff<void>

Added in v0.0.1