Class: HtmlToMarkdown::ConversionOptionsUpdate

Inherits:
Object
  • Object
show all
Defined in:
sig/types.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ConversionOptionsUpdate

Returns a new instance of ConversionOptionsUpdate.

Parameters:

  • heading_style: (HeadingStyle)
  • list_indent_type: (ListIndentType)
  • list_indent_width: (Integer)
  • bullets: (String)
  • strong_em_symbol: (String)
  • escape_asterisks: (Boolean)
  • escape_underscores: (Boolean)
  • escape_misc: (Boolean)
  • escape_ascii: (Boolean)
  • code_language: (String)
  • autolinks: (Boolean)
  • default_title: (Boolean)
  • br_in_tables: (Boolean)
  • compact_tables: (Boolean)
  • highlight_style: (HighlightStyle)
  • extract_metadata: (Boolean)
  • whitespace_mode: (WhitespaceMode)
  • strip_newlines: (Boolean)
  • wrap: (Boolean)
  • wrap_width: (Integer)
  • convert_as_inline: (Boolean)
  • sub_symbol: (String)
  • sup_symbol: (String)
  • newline_style: (NewlineStyle)
  • code_block_style: (CodeBlockStyle)
  • keep_inline_images_in: (Array[String])
  • preprocessing: (PreprocessingOptionsUpdate)
  • encoding: (String)
  • debug: (Boolean)
  • strip_tags: (Array[String])
  • preserve_tags: (Array[String])
  • skip_images: (Boolean)
  • url_escape_style: (UrlEscapeStyle)
  • link_style: (LinkStyle)
  • output_format: (OutputFormat)
  • include_document_structure: (Boolean)
  • extract_images: (Boolean)
  • max_image_size: (Integer)
  • capture_svg: (Boolean)
  • infer_dimensions: (Boolean)
  • max_depth: (Integer, nil)
  • exclude_selectors: (Array[String])
  • tier_strategy: (TierStrategy)
  • visitor: (VisitorHandle) 


175
 
# File 'sig/types.rbs', line 175

def initialize: (?heading_style: HeadingStyle, ?list_indent_type: ListIndentType, ?list_indent_width: Integer, ?bullets: String, ?strong_em_symbol: String, ?escape_asterisks: bool, ?escape_underscores: bool, ?escape_misc: bool, ?escape_ascii: bool, ?code_language: String, ?autolinks: bool, ?default_title: bool, ?br_in_tables: bool, ?compact_tables: bool, ?highlight_style: HighlightStyle, ?extract_metadata: bool, ?whitespace_mode: WhitespaceMode, ?strip_newlines: bool, ?wrap: bool, ?wrap_width: Integer, ?convert_as_inline: bool, ?sub_symbol: String, ?sup_symbol: String, ?newline_style: NewlineStyle, ?code_block_style: CodeBlockStyle, ?keep_inline_images_in: Array[String], ?preprocessing: PreprocessingOptionsUpdate, ?encoding: String, ?debug: bool, ?strip_tags: Array[String], ?preserve_tags: Array[String], ?skip_images: bool, ?url_escape_style: UrlEscapeStyle, ?link_style: LinkStyle, ?output_format: OutputFormat, ?include_document_structure: bool, ?extract_images: bool, ?max_image_size: Integer, ?capture_svg: bool, ?infer_dimensions: bool, ?max_depth: Integer?, ?exclude_selectors: Array[String], ?tier_strategy: TierStrategy, ?visitor: VisitorHandle) -> void

Instance Attribute Details

Returns the value of attribute autolinks.

Returns:

  • (Boolean, nil) 


140
141
142
 
# File 'sig/types.rbs', line 140

def autolinks
  @autolinks
end

#br_in_tables ⇒ Boolean?

Returns the value of attribute br_in_tables.

Returns:

  • (Boolean, nil) 


142
143
144
 
# File 'sig/types.rbs', line 142

def br_in_tables
  @br_in_tables
end

#bullets ⇒ String?

Returns the value of attribute bullets.

Returns:

  • (String, nil) 


133
134
135
 
# File 'sig/types.rbs', line 133

def bullets
  @bullets
end

#capture_svg ⇒ Boolean?

Returns the value of attribute capture_svg.

Returns:

  • (Boolean, nil) 


168
169
170
 
# File 'sig/types.rbs', line 168

def capture_svg
  @capture_svg
end

#code_block_style ⇒ CodeBlockStyle?

Returns the value of attribute code_block_style.

Returns:



154
155
156
 
# File 'sig/types.rbs', line 154

def code_block_style
  @code_block_style
end

#code_language ⇒ String?

Returns the value of attribute code_language.

Returns:

  • (String, nil) 


139
140
141
 
# File 'sig/types.rbs', line 139

def code_language
  @code_language
end

#compact_tables ⇒ Boolean?

Returns the value of attribute compact_tables.

Returns:

  • (Boolean, nil) 


143
144
145
 
# File 'sig/types.rbs', line 143

def compact_tables
  @compact_tables
end

#convert_as_inline ⇒ Boolean?

Returns the value of attribute convert_as_inline.

Returns:

  • (Boolean, nil) 


150
151
152
 
# File 'sig/types.rbs', line 150

def convert_as_inline
  @convert_as_inline
end

#debug ⇒ Boolean?

Returns the value of attribute debug.

Returns:

  • (Boolean, nil) 


158
159
160
 
# File 'sig/types.rbs', line 158

def debug
  @debug
end

#default_title ⇒ Boolean?

Returns the value of attribute default_title.

Returns:

  • (Boolean, nil) 


141
142
143
 
# File 'sig/types.rbs', line 141

def default_title
  @default_title
end

#encoding ⇒ String?

Returns the value of attribute encoding.

Returns:

  • (String, nil) 


157
158
159
 
# File 'sig/types.rbs', line 157

def encoding
  @encoding
end

#escape_ascii ⇒ Boolean?

Returns the value of attribute escape_ascii.

Returns:

  • (Boolean, nil) 


138
139
140
 
# File 'sig/types.rbs', line 138

def escape_ascii
  @escape_ascii
end

#escape_asterisks ⇒ Boolean?

Returns the value of attribute escape_asterisks.

Returns:

  • (Boolean, nil) 


135
136
137
 
# File 'sig/types.rbs', line 135

def escape_asterisks
  @escape_asterisks
end

#escape_misc ⇒ Boolean?

Returns the value of attribute escape_misc.

Returns:

  • (Boolean, nil) 


137
138
139
 
# File 'sig/types.rbs', line 137

def escape_misc
  @escape_misc
end

#escape_underscores ⇒ Boolean?

Returns the value of attribute escape_underscores.

Returns:

  • (Boolean, nil) 


136
137
138
 
# File 'sig/types.rbs', line 136

def escape_underscores
  @escape_underscores
end

#exclude_selectors ⇒ Array[String]?

Returns the value of attribute exclude_selectors.

Returns:

  • (Array[String], nil) 


171
172
173
 
# File 'sig/types.rbs', line 171

def exclude_selectors
  @exclude_selectors
end

#extract_images ⇒ Boolean?

Returns the value of attribute extract_images.

Returns:

  • (Boolean, nil) 


166
167
168
 
# File 'sig/types.rbs', line 166

def extract_images
  @extract_images
end

#extract_metadata ⇒ Boolean?

Returns the value of attribute extract_metadata.

Returns:

  • (Boolean, nil) 


145
146
147
 
# File 'sig/types.rbs', line 145

def extract_metadata
  @extract_metadata
end

#heading_style ⇒ HeadingStyle?

Returns the value of attribute heading_style.

Returns:



130
131
132
 
# File 'sig/types.rbs', line 130

def heading_style
  @heading_style
end

#highlight_style ⇒ HighlightStyle?

Returns the value of attribute highlight_style.

Returns:



144
145
146
 
# File 'sig/types.rbs', line 144

def highlight_style
  @highlight_style
end

#include_document_structure ⇒ Boolean?

Returns the value of attribute include_document_structure.

Returns:

  • (Boolean, nil) 


165
166
167
 
# File 'sig/types.rbs', line 165

def include_document_structure
  @include_document_structure
end

#infer_dimensions ⇒ Boolean?

Returns the value of attribute infer_dimensions.

Returns:

  • (Boolean, nil) 


169
170
171
 
# File 'sig/types.rbs', line 169

def infer_dimensions
  @infer_dimensions
end

#keep_inline_images_in ⇒ Array[String]?

Returns the value of attribute keep_inline_images_in.

Returns:

  • (Array[String], nil) 


155
156
157
 
# File 'sig/types.rbs', line 155

def keep_inline_images_in
  @keep_inline_images_in
end

#link_style ⇒ LinkStyle?

Returns the value of attribute link_style.

Returns:



163
164
165
 
# File 'sig/types.rbs', line 163

def link_style
  @link_style
end

#list_indent_type ⇒ ListIndentType?

Returns the value of attribute list_indent_type.

Returns:



131
132
133
 
# File 'sig/types.rbs', line 131

def list_indent_type
  @list_indent_type
end

#list_indent_width ⇒ Integer?

Returns the value of attribute list_indent_width.

Returns:

  • (Integer, nil) 


132
133
134
 
# File 'sig/types.rbs', line 132

def list_indent_width
  @list_indent_width
end

#max_depth ⇒ Integer?

Returns the value of attribute max_depth.

Returns:

  • (Integer, nil) 


170
171
172
 
# File 'sig/types.rbs', line 170

def max_depth
  @max_depth
end

#max_image_size ⇒ Integer?

Returns the value of attribute max_image_size.

Returns:

  • (Integer, nil) 


167
168
169
 
# File 'sig/types.rbs', line 167

def max_image_size
  @max_image_size
end

#newline_style ⇒ NewlineStyle?

Returns the value of attribute newline_style.

Returns:



153
154
155
 
# File 'sig/types.rbs', line 153

def newline_style
  @newline_style
end

#output_format ⇒ OutputFormat?

Returns the value of attribute output_format.

Returns:



164
165
166
 
# File 'sig/types.rbs', line 164

def output_format
  @output_format
end

#preprocessing ⇒ PreprocessingOptionsUpdate?

Returns the value of attribute preprocessing.

Returns:



156
157
158
 
# File 'sig/types.rbs', line 156

def preprocessing
  @preprocessing
end

#preserve_tags ⇒ Array[String]?

Returns the value of attribute preserve_tags.

Returns:

  • (Array[String], nil) 


160
161
162
 
# File 'sig/types.rbs', line 160

def preserve_tags
  @preserve_tags
end

#skip_images ⇒ Boolean?

Returns the value of attribute skip_images.

Returns:

  • (Boolean, nil) 


161
162
163
 
# File 'sig/types.rbs', line 161

def skip_images
  @skip_images
end

#strip_newlines ⇒ Boolean?

Returns the value of attribute strip_newlines.

Returns:

  • (Boolean, nil) 


147
148
149
 
# File 'sig/types.rbs', line 147

def strip_newlines
  @strip_newlines
end

#strip_tags ⇒ Array[String]?

Returns the value of attribute strip_tags.

Returns:

  • (Array[String], nil) 


159
160
161
 
# File 'sig/types.rbs', line 159

def strip_tags
  @strip_tags
end

#strong_em_symbol ⇒ String?

Returns the value of attribute strong_em_symbol.

Returns:

  • (String, nil) 


134
135
136
 
# File 'sig/types.rbs', line 134

def strong_em_symbol
  @strong_em_symbol
end

#sub_symbol ⇒ String?

Returns the value of attribute sub_symbol.

Returns:

  • (String, nil) 


151
152
153
 
# File 'sig/types.rbs', line 151

def sub_symbol
  @sub_symbol
end

#sup_symbol ⇒ String?

Returns the value of attribute sup_symbol.

Returns:

  • (String, nil) 


152
153
154
 
# File 'sig/types.rbs', line 152

def sup_symbol
  @sup_symbol
end

#tier_strategy ⇒ TierStrategy?

Returns the value of attribute tier_strategy.

Returns:



172
173
174
 
# File 'sig/types.rbs', line 172

def tier_strategy
  @tier_strategy
end

#url_escape_style ⇒ UrlEscapeStyle?

Returns the value of attribute url_escape_style.

Returns:



162
163
164
 
# File 'sig/types.rbs', line 162

def url_escape_style
  @url_escape_style
end

#visitor ⇒ VisitorHandle?

Returns the value of attribute visitor.

Returns:



173
174
175
 
# File 'sig/types.rbs', line 173

def visitor
  @visitor
end

#whitespace_mode ⇒ WhitespaceMode?

Returns the value of attribute whitespace_mode.

Returns:



146
147
148
 
# File 'sig/types.rbs', line 146

def whitespace_mode
  @whitespace_mode
end

#wrap ⇒ Boolean?

Returns the value of attribute wrap.

Returns:

  • (Boolean, nil) 


148
149
150
 
# File 'sig/types.rbs', line 148

def wrap
  @wrap
end

#wrap_width ⇒ Integer?

Returns the value of attribute wrap_width.

Returns:

  • (Integer, nil) 


149
150
151
 
# File 'sig/types.rbs', line 149

def wrap_width
  @wrap_width
end