6.45. kink/doc/model/BLOCK

6.45.1. block型

blockは、kinkdoc文書の中のブロックである。

block値は次の属性を持つ。

• Type: JSONデータの "type" 属性に相当するblock_type値

• Text: JSONデータの "text" 属性に相当するstr値

6.45.1.1. Block.type

typeメソッドは、BlockのType属性を戻す。

6.45.1.2. Block.text

textメソッドは、BlockのText属性を戻す。

6.45.1.3. Block.to_json_val

to_json_valは、BlockをJSON値に変換する。

:BLOCK.require_from('kink/doc/model/')
:BLOCK_TYPE.require_from('kink/doc/model/')

:Para <- BLOCK.new(BLOCK_TYPE.paragraph 'hey!')
stdout.print_line(Para.to_json_val.repr)
# => Flat_map("text" "hey!"; "type" "paragraph")

:Code <- BLOCK.new(BLOCK_TYPE.code "1 + 2\n")
stdout.print_line(Code.to_json_val.repr)
# => Flat_map("text" "1 + 2\n"; "type" "code")

6.45.1.4. X == Y

ふたつのblock値は、両者が等しいType属性とText属性を持っているときに等しい。

事前条件

Yはblockでなければならない。

6.45.2. BLOCK.new(Type Text)

newは、属性TypeとTextを持つ新しいblock値を戻す。

事前条件

Typeはblock_type値でなければならない。

Textはstr値でなければならない。

`Type.valid_text?(Text)` が真でなければならない。

6.45.3. BLOCK.is?(Val)

is?は、Valがblock値であるかどうかを戻す。