class Lightning::Method

Constants

TYPE

Attributes

desc[R]
long_desc[R]
name[R]
type[R]
usage[R]

Public Class Methods

new(name, usage = nil, desc = nil, type: TYPE[:rpc], long_desc: nil) click to toggle source
# File lib/lightning/plugin.rb, line 16
def initialize(name, usage = nil, desc = nil, type: TYPE[:rpc], long_desc: nil)
  @name = name
  @type = type
  @usage = usage
  @desc = desc
  @long_desc = long_desc
end

Public Instance Methods

hook?() click to toggle source
# File lib/lightning/plugin.rb, line 28
def hook?
  type == TYPE[:hook]
end
rpc?() click to toggle source
# File lib/lightning/plugin.rb, line 24
def rpc?
  type == TYPE[:rpc] && ![:init, :getmanifest].include?(name)
end
to_h() click to toggle source
# File lib/lightning/plugin.rb, line 32
def to_h
  result = {name: name.to_s, usage: usage, description: desc}
  result[:long_description] = long_desc if long_desc
  result
end