Skip to content

Rename the APIs more explicitly for better readability #99

Description

@harendra-kumar

toStdout "ls" feels like we want to send a string a to stdout. We can use an explicit "run" or "exec" in the name to make it explicit that we are executing it as a command.

There are three types of APIs, source, sink and pipe. We can use the following scheme to indicate that it generates output only, takes input only or does both:

  • runGenBytes (currently toBytes) - altrenative runToBytes
  • runSinkBytes - alternative runUseBytes
  • runPipeBytes (currently pipeBytes)

For a pure side effect command without any input or output we can use "run". For standalone processes:

  • runStandalone
  • runForeground
  • runDaemon

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions