Method: Chef::Resource.preview_resource

Defined in:
lib/chef/resource.rb

.preview_resource(value = nil) ⇒ Boolean

Set or return if this resource is in preview mode.

This only has value in the resource_inspector to mark a resource as being new-to-chef-core. Its meaning is probably more equivalent to “experimental” in that the API might change even in minor versions due to bugfixing and is NOT considered “stable” yet.

Parameters:

  • value (nil, Boolean) (defaults to: nil)

    If nil, get the current value. If not nil, set the value of the flag.

Returns:

  • (Boolean)


1211
1212
1213
1214
1215
# File 'lib/chef/resource.rb', line 1211

def self.preview_resource(value = nil)
  @preview_resource = false unless defined?(@preview_resource)
  @preview_resource = value unless value.nil?
  @preview_resource
end