Class: Toys::Completion::Base

Inherits:

Object

• Object
• Toys::Completion::Base

Defined in:

core-docs/toys/completion.rb

Overview

Defined in the toys-core gem

A base class that returns no completions.

Completions may but do not need to subclass this base class. They merely need to duck-type Proc by implementing the call method.

Direct Known Subclasses

Toys::CLI::DefaultCompletion, Enum, FileSystem, Flag::DefaultCompletion, ToolDefinition::DefaultCompletion

Instance Method Summary

• #call(context) ⇒ Array<Toys::Completion::Candidate>

  Returns candidates for the current completion.

Instance Method Details

#call(context) ⇒ Array<Toys::Completion::Candidate>

Returns candidates for the current completion. This default implementation returns an empty list.

Parameters:

• context (Toys::Completion::Context) —

  The current completion context including the string fragment.

Returns:

• (Array<Toys::Completion::Candidate>) —

  An array of candidates

# File 'core-docs/toys/completion.rb', line 183

def call(context)
  # Source available in the toys-core gem
end