gem.sh gem.sh
Home Gems Types Docs Community
  • Modules

    • module Kernel
    • module RBS
    • module RBS::AST
    • module RBS::AST::Declarations
    • module RBS::AST::Declarations::MixinHelper
    • module RBS::AST::Declarations::NestedDeclarationHelper
    • module RBS::AST::Directives
    • module RBS::AST::Members
    • module RBS::AST::Members::Attribute
    • module RBS::AST::Members::LocationOnly
    • module RBS::AST::Members::Mixin
    • module RBS::AST::Members::Var
    • module RBS::Annotate
    • module RBS::BuiltinNames
    • module RBS::Collection
    • module RBS::Collection::Sources
    • module RBS::Collection::Sources::Base
    • module RBS::Definition::Ancestor
    • module RBS::DetailedMessageable
    • module RBS::Environment::ContextUtil
    • module RBS::FileFinder
    • module RBS::MethodNameHelper
    • module RBS::Prototype
    • module RBS::Prototype::Helpers
    • module RBS::Prototype::Runtime::Helpers
    • module RBS::Prototype::Runtime::Reflection
    • module RBS::RDocPlugin
    • module RBS::Resolver
    • module RBS::Test
    • module RBS::Test::Errors
    • module RBS::Test::Guaranteed
    • module RBS::Test::Guaranteed::Inspect
    • module RBS::Test::Hook
    • module RBS::Test::Observer
    • module RBS::Test::SetupHelper
    • module RBS::Types
    • module RBS::Types::Application
    • module RBS::Types::Bases
    • module RBS::Types::EmptyEachType
    • module RBS::Types::NoFreeVariables
    • module RBS::Types::NoSubst
    • module RBS::Types::NoTypeName
    • module RBS::Types::SelfTypeBindingHelper
    • module RBS::UnitTest
    • module RBS::UnitTest::Convertibles
    • module RBS::UnitTest::Spy
    • module RBS::UnitTest::TypeAssertions
    • module RBS::UnitTest::TypeAssertions::ClassMethods
    • module RBS::UnitTest::WithAliases
    • module RDoc
  • Classes

    • class Module
    • class Proc
    • class RBS::AST::Annotation
    • class RBS::AST::Comment
    • class RBS::AST::Declarations::AliasDecl
    • class RBS::AST::Declarations::Base
    • class RBS::AST::Declarations::Class
    • class RBS::AST::Declarations::Class::Super
    • class RBS::AST::Declarations::ClassAlias
    • class RBS::AST::Declarations::Constant
    • class RBS::AST::Declarations::Global
    • class RBS::AST::Declarations::Interface
    • class RBS::AST::Declarations::Module
    • class RBS::AST::Declarations::Module::Self
    • class RBS::AST::Declarations::ModuleAlias
    • class RBS::AST::Declarations::TypeAlias
    • class RBS::AST::Directives::Base
    • class RBS::AST::Directives::ResolveTypeNames
    • class RBS::AST::Directives::Use
    • class RBS::AST::Directives::Use::SingleClause
    • class RBS::AST::Directives::Use::WildcardClause
    • class RBS::AST::Members::Alias
    • class RBS::AST::Members::AttrAccessor
    • class RBS::AST::Members::AttrReader
    • class RBS::AST::Members::AttrWriter
    • class RBS::AST::Members::Base
    • class RBS::AST::Members::ClassInstanceVariable
    • class RBS::AST::Members::ClassVariable
    • class RBS::AST::Members::Extend
    • class RBS::AST::Members::Include
    • class RBS::AST::Members::InstanceVariable
    • class RBS::AST::Members::MethodDefinition
    • class RBS::AST::Members::MethodDefinition::Overload
    • class RBS::AST::Members::Prepend
    • class RBS::AST::Members::Private
    • class RBS::AST::Members::Public
    • class RBS::AST::TypeParam
    • class RBS::AST::Visitor
    • class RBS::AncestorGraph
    • class RBS::Annotate::Annotations
    • class RBS::Annotate::Annotations::Copy
    • class RBS::Annotate::Annotations::Skip
    • class RBS::Annotate::Annotations::Source
    • class RBS::Annotate::Formatter
    • class RBS::Annotate::RDocAnnotator
    • class RBS::Annotate::RDocSource
    • class RBS::BaseError
    • class RBS::Buffer
    • class RBS::BuiltinNames::Name
    • class RBS::CLI
    • class RBS::CLI::ColoredIO
    • class RBS::CLI::Diff
    • class RBS::CLI::LibraryOptions
    • class RBS::CLI::Validate
    • class RBS::CLI::Validate::Errors
    • class RBS::ClassInstanceVariableDuplicationError
    • class RBS::Collection::Cleaner
    • class RBS::Collection::Config
    • class RBS::Collection::Config::CollectionNotAvailable
    • class RBS::Collection::Config::Lockfile
    • class RBS::Collection::Config::LockfileGenerator
    • class RBS::Collection::Config::LockfileGenerator::GemfileLockMismatchError
    • class RBS::Collection::Installer
    • class RBS::Collection::Sources::Git
    • class RBS::Collection::Sources::Git::CommandError
    • class RBS::Collection::Sources::Local
    • class RBS::Collection::Sources::Rubygems
    • class RBS::Collection::Sources::Stdlib
    • class RBS::Constant
    • class RBS::CyclicClassAliasDefinitionError
    • class RBS::CyclicTypeParameterBound
    • class RBS::Definition
    • class RBS::Definition::Ancestor::Instance
    • class RBS::Definition::Ancestor::Singleton
    • class RBS::Definition::InstanceAncestors
    • class RBS::Definition::Method
    • class RBS::Definition::Method::TypeDef
    • class RBS::Definition::SingletonAncestors
    • class RBS::Definition::Variable
    • class RBS::DefinitionBuilder
    • class RBS::DefinitionBuilder::AncestorBuilder
    • class RBS::DefinitionBuilder::AncestorBuilder::OneAncestors
    • class RBS::DefinitionBuilder::MethodBuilder
    • class RBS::DefinitionBuilder::MethodBuilder::Methods
    • class RBS::DefinitionBuilder::MethodBuilder::Methods::Definition
    • class RBS::DefinitionBuilder::MethodBuilder::Methods::Sorter
    • class RBS::DefinitionError
    • class RBS::Diff
    • class RBS::DuplicatedDeclarationError
    • class RBS::DuplicatedInterfaceMethodDefinitionError
    • class RBS::DuplicatedMethodDefinitionError
    • class RBS::Environment
    • class RBS::Environment::ClassAliasEntry
    • class RBS::Environment::ClassEntry
    • class RBS::Environment::ConstantEntry
    • class RBS::Environment::GlobalEntry
    • class RBS::Environment::InterfaceEntry
    • class RBS::Environment::ModuleAliasEntry
    • class RBS::Environment::ModuleEntry
    • class RBS::Environment::MultiEntry
    • class RBS::Environment::SingleEntry
    • class RBS::Environment::TypeAliasEntry
    • class RBS::Environment::UseMap
    • class RBS::Environment::UseMap::Table
    • class RBS::EnvironmentLoader
    • class RBS::EnvironmentLoader::Library
    • class RBS::EnvironmentLoader::UnknownLibraryError
    • class RBS::EnvironmentWalker
    • class RBS::Factory
    • class RBS::GenericParameterMismatchError
    • class RBS::InconsistentClassModuleAliasError
    • class RBS::InheritModuleError
    • class RBS::InstanceVariableDuplicationError
    • class RBS::InvalidOverloadMethodError
    • class RBS::InvalidTypeApplicationError
    • class RBS::InvalidVarianceAnnotationError
    • class RBS::LoadingError
    • class RBS::Location
    • class RBS::Locator
    • class RBS::MethodType
    • class RBS::MixinClassError
    • class RBS::Namespace
    • class RBS::NoMixinFoundError
    • class RBS::NoSelfTypeFoundError
    • class RBS::NoSuperclassFoundError
    • class RBS::NoTypeFoundError
    • class RBS::NonregularTypeAliasError
    • class RBS::Parser
    • class RBS::Parser::LexResult
    • class RBS::Parser::Token
    • class RBS::ParsingError
    • class RBS::Prototype::NodeUsage
    • class RBS::Prototype::RB
    • class RBS::Prototype::RB::Context
    • class RBS::Prototype::RBI
    • class RBS::Prototype::Runtime
    • class RBS::Prototype::Runtime::DataGenerator
    • class RBS::Prototype::Runtime::StructGenerator
    • class RBS::Prototype::Runtime::Todo
    • class RBS::Prototype::Runtime::ValueObjectBase
    • class RBS::RDocPlugin::Parser
    • class RBS::RecursiveAliasDefinitionError
    • class RBS::RecursiveAncestorError
    • class RBS::RecursiveTypeAliasError
    • class RBS::Repository
    • class RBS::Repository::GemRBS
    • class RBS::Resolver::ConstantResolver
    • class RBS::Resolver::ConstantResolver::Table
    • class RBS::Resolver::TypeNameResolver
    • class RBS::Sorter
    • class RBS::Substitution
    • class RBS::Subtractor
    • class RBS::SuperclassMismatchError
    • class RBS::Test::ArgumentsReturn
    • class RBS::Test::SetupHelper::InvalidSampleSizeError
    • class RBS::Test::Tester
    • class RBS::Test::Tester::MethodCallTester
    • class RBS::Test::Tester::TypeError
    • class RBS::Test::TypeCheck
    • class RBS::TypeAliasDependency
    • class RBS::TypeAliasRegularity
    • class RBS::TypeAliasRegularity::Diagnostic
    • class RBS::TypeName
    • class RBS::TypeParamDefaultReferenceError
    • class RBS::Types::Alias
    • class RBS::Types::Bases::Any
    • class RBS::Types::Bases::Base
    • class RBS::Types::Bases::Bool
    • class RBS::Types::Bases::Bottom
    • class RBS::Types::Bases::Class
    • class RBS::Types::Bases::Instance
    • class RBS::Types::Bases::Nil
    • class RBS::Types::Bases::Self
    • class RBS::Types::Bases::Top
    • class RBS::Types::Bases::Void
    • class RBS::Types::Block
    • class RBS::Types::ClassInstance
    • class RBS::Types::ClassSingleton
    • class RBS::Types::Function
    • class RBS::Types::Function::Param
    • class RBS::Types::Interface
    • class RBS::Types::Intersection
    • class RBS::Types::Literal
    • class RBS::Types::Optional
    • class RBS::Types::Proc
    • class RBS::Types::Record
    • class RBS::Types::Tuple
    • class RBS::Types::Union
    • class RBS::Types::UntypedFunction
    • class RBS::Types::Variable
    • class RBS::UnitTest::Convertibles::BlankSlate
    • class RBS::UnitTest::Convertibles::CustomRange
    • class RBS::UnitTest::Convertibles::Each
    • class RBS::UnitTest::Convertibles::ToA
    • class RBS::UnitTest::Convertibles::ToArray
    • class RBS::UnitTest::Convertibles::ToC
    • class RBS::UnitTest::Convertibles::ToF
    • class RBS::UnitTest::Convertibles::ToHash
    • class RBS::UnitTest::Convertibles::ToI
    • class RBS::UnitTest::Convertibles::ToIO
    • class RBS::UnitTest::Convertibles::ToInt
    • class RBS::UnitTest::Convertibles::ToPath
    • class RBS::UnitTest::Convertibles::ToR
    • class RBS::UnitTest::Convertibles::ToS
    • class RBS::UnitTest::Convertibles::ToStr
    • class RBS::UnitTest::Convertibles::ToSym
    • class RBS::UnitTest::Spy::WrapSpy
    • class RBS::UnitTest::WithAliases::WithEnum
    • class RBS::UnknownMethodAliasError
    • class RBS::Validator
    • class RBS::VariableDuplicationError
    • class RBS::VarianceCalculator
    • class RBS::VarianceCalculator::Result
    • class RBS::Vendorer
    • class RBS::WillSyntaxError
    • class RBS::Writer
    • class RDoc::Parser
    • class RDoc::Parser::RBS
    Overview
    H
    Home
    R
    Reference
    T
    Types
    C
    Changelogs
  • Documentation
    • README
    • Contributing
    • Architecture
    • Collection
    • Data and struct
    • Gem
    • RBS by example
    • Repo
    • Sigs
    • Stdlib
    • Syntax
    • Tools
  • More
    • Versions
    • Source
    • Playground
    • Stats
    • Metadata
    • Wiki
    • Announcements
    Community
    • Articles
    • Tutorials
    • Videos
    • Community
  1. Gems
  2. rbs

rbs

RBS is the language for type signatures for Ruby and standard library definitions.

Types
Docs
Guides
Zeitwerk
Namespace
Optimized

Version

3.9.4

Authors

Soutaro Matsumoto

Dependencies

logger

Quick Start

bundle add rbs

Getting Started

Learn more about the Rbs gem.

Installation

Learn more about how to install and configure the gem

Documentation

Learn more about the details

Guides

Learn more about the gem in the written guides

Reference

Learn more about the classes and modules

Documentation

docs/CONTRIBUTING.md

Read about "Contributing" in rbs

Read more

docs/architecture.md

Read about "Architecture" in rbs

Read more

docs/collection.md

Read about "Collection" in rbs

Read more

docs/data_and_struct.md

Read about "Data and struct" in rbs

Read more

Playground

Test, play and inspect the gem for yourself

irb(main):001:0>

            

Playground

Run a Ruby playground with the rbs gem pre-installed

Play

Top-Level Modules

  • Kernel
  • RBS
  • RDoc

Top-Level Classes

  • Module
  • Proc

Top-Level Instance Methods

  • # context
  • # match
  • # to_absolute_typename
Home
Gems
Docs
Contribute
Monitoring
Twitter GitHub Mastodon

© 2025 gem.sh - Beautiful documentation for any Ruby gem