DOCUMENTATION.md

Documentation

You can see below the API reference of this module.

Gry(options)

Creates a new Gry instance.

Params

• Object options: An object containing the following fields:
• path (String): The path to the git repository.
• limit (Number): The limit of commands to run same time.

Return

• Gry The Gry instance.

exec(command, args, callback)

Executes a git command in the repository directory.

Params

• String command: The git command that should be executed in the repository directory.
• Array args: An array of options passed to the spawned process. This is optional (if not provided, exec will be used instead).
• Function callback: The callback function.

Return

• Gry The Gry instance.

init(callback)

Inits the git repository.

Params

• Function callback: The callback function.

Return

• Gry The Gry instance.

create(path, callback)

Creates a git repository.

Params

• String path: The path of the repository.
• Function callback: The callback function

Return

• Gry The Gry instance.

commit(message, options, callback)

Creates a commit, providing the message.

Params

• String message: The commit message
• String options: Additional options passed to the commit command.
• Function callback: The callback function.

Return

• Gry The Gry instance.