Verb options

One interface per verb. Each is the shape of the opts argument accepted by both the free function (verbs.X(noggin, opts)) and the bound method (noggin.X(opts)). CloseOptions is a shared mixin for the closing verbs; GotoOption is a mixin for the --goto follow-up flag.

PushOptions

Properties

Property	Type
`title`	`string`

AddOptions

Extends

GotoOption

Properties

Property	Type	Description	Inherited from
`goto?`	`string` \	`true`	Path resolved relative to the operation's target. `true` means `.`.	`GotoOption`.`goto`
`placement?`	`Placement`	-	-
`title`	`string`	-	-

MoveOptions

Extends

GotoOption

Properties

Property	Type	Description	Inherited from
`goto?`	`string` \	`true`	Path resolved relative to the operation's target. `true` means `.`.	`GotoOption`.`goto`
`path?`	`string`	-	-
`placement`	`Placement`	-	-

GotoOptions

Properties

Property	Type
`path`	`string`

DoneOptions

Extends

CloseOptions

Properties

Property	Type	Inherited from
`closeAll?`	`boolean`	`CloseOptions`.`closeAll`
`force?`	`boolean`	`CloseOptions`.`force`
`path?`	`string`	-

PopOptions

Extends

CloseOptions

Properties

Property	Type	Inherited from
`closeAll?`	`boolean`	`CloseOptions`.`closeAll`
`force?`	`boolean`	`CloseOptions`.`force`

EditOptions

Extends

GotoOption.CloseOptions

Properties

Property	Type	Description	Inherited from
`closeAll?`	`boolean`	-	`CloseOptions`.`closeAll`
`done?`	`boolean`	-	-
`force?`	`boolean`	-	`CloseOptions`.`force`
`goto?`	`string` \	`true`	Path resolved relative to the operation's target. `true` means `.`.	`GotoOption`.`goto`
`path?`	`string`	-	-
`title?`	`string`	-	-

ShowOptions

Extends

GotoOption

Properties

Property	Type	Description	Inherited from
`goto?`	`string` \	`true`	Path resolved relative to the operation's target. `true` means `.`.	`GotoOption`.`goto`
`includeChildren?`	`boolean`	-	-
`path?`	`string`	-	-
`withDescendants?`	`boolean`	-	-
`withNotes?`	`boolean`	-	-
`withSiblings?`	`boolean`	-	-

NoteOptions

Extends

GotoOption

Properties

Property	Type	Description	Inherited from
`goto?`	`string` \	`true`	Path resolved relative to the operation's target. `true` means `.`.	`GotoOption`.`goto`
`path?`	`string`	-	-
`text`	`string`	-	-

DeleteOptions

Properties

Property	Type
`path`	`string`
`recursive?`	`boolean`

CopyOptions

Options for Verbs.copy. Reserved for forward-compat — v1 has no options.

CloseOptions

Shared shape for closing verbs (done, pop, edit --done).

Properties

Property	Type
`closeAll?`	`boolean`
`force?`	`boolean`

GotoOption

Optional reposition-after-write. Mirrors the CLI --goto flag.

Extended by

AddOptions
MoveOptions
EditOptions
ShowOptions
NoteOptions

Properties

Property	Type	Description
`goto?`	`string` \	`true`	Path resolved relative to the operation's target. `true` means `.`.