schlechtenburg/packages/standalone/docs/lib.json

{
  "id": 0,
  "name": "@schlechtenburg/standalone",
  "kind": 1,
  "kindString": "Project",
  "flags": {},
  "originalName": "",
  "children": [
    {
      "id": 1,
      "name": "startSchlechtenburg",
      "kind": 64,
      "kindString": "Function",
      "flags": {},
      "sources": [
        {
          "fileName": "main.ts",
          "line": 13,
          "character": 13
        }
      ],
      "signatures": [
        {
          "id": 2,
          "name": "startSchlechtenburg",
          "kind": 4096,
          "kindString": "Call signature",
          "flags": {},
          "comment": {
            "shortText": "Initializes the Schlechtenburg editor",
            "returns": "A set of functions to interact with the live Schlechtenburg instance\n"
          },
          "parameters": [
            {
              "id": 3,
              "name": "el",
              "kind": 32768,
              "kindString": "Parameter",
              "flags": {},
              "comment": {
                "shortText": "The element on which the editor schould be mounted"
              },
              "type": {
                "type": "union",
                "types": [
                  {
                    "type": "intrinsic",
                    "name": "string"
                  },
                  {
                    "type": "reference",
                    "qualifiedName": "HTMLElement",
                    "package": "typescript",
                    "name": "HTMLElement"
                  }
                ]
              }
            },
            {
              "id": 4,
              "name": "props",
              "kind": 32768,
              "kindString": "Parameter",
              "flags": {},
              "comment": {
                "shortText": "The Schlechtenburg props\n"
              },
              "type": {
                "type": "reference",
                "name": "ISbMainProps"
              }
            }
          ],
          "type": {
            "type": "reference",
            "typeArguments": [
              {
                "type": "reflection",
                "declaration": {
                  "id": 5,
                  "name": "__type",
                  "kind": 65536,
                  "kindString": "Type literal",
                  "flags": {},
                  "children": [
                    {
                      "id": 6,
                      "name": "getBlock",
                      "kind": 1024,
                      "kindString": "Property",
                      "flags": {},
                      "type": {
                        "type": "reflection",
                        "declaration": {
                          "id": 7,
                          "name": "__type",
                          "kind": 65536,
                          "kindString": "Type literal",
                          "flags": {},
                          "signatures": [
                            {
                              "id": 8,
                              "name": "__type",
                              "kind": 4096,
                              "kindString": "Call signature",
                              "flags": {},
                              "type": {
                                "type": "union",
                                "types": [
                                  {
                                    "type": "literal",
                                    "value": null
                                  },
                                  {
                                    "type": "reference",
                                    "typeArguments": [
                                      {
                                        "type": "intrinsic",
                                        "name": "any"
                                      }
                                    ],
                                    "name": "IBlockData"
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      }
                    },
                    {
                      "id": 13,
                      "name": "getMode",
                      "kind": 1024,
                      "kindString": "Property",
                      "flags": {},
                      "type": {
                        "type": "reflection",
                        "declaration": {
                          "id": 14,
                          "name": "__type",
                          "kind": 65536,
                          "kindString": "Type literal",
                          "flags": {},
                          "signatures": [
                            {
                              "id": 15,
                              "name": "__type",
                              "kind": 4096,
                              "kindString": "Call signature",
                              "flags": {},
                              "type": {
                                "type": "reference",
                                "name": "SbMode"
                              }
                            }
                          ]
                        }
                      }
                    },
                    {
                      "id": 9,
                      "name": "setBlock",
                      "kind": 1024,
                      "kindString": "Property",
                      "flags": {},
                      "type": {
                        "type": "reflection",
                        "declaration": {
                          "id": 10,
                          "name": "__type",
                          "kind": 65536,
                          "kindString": "Type literal",
                          "flags": {},
                          "signatures": [
                            {
                              "id": 11,
                              "name": "__type",
                              "kind": 4096,
                              "kindString": "Call signature",
                              "flags": {},
                              "parameters": [
                                {
                                  "id": 12,
                                  "name": "block",
                                  "kind": 32768,
                                  "kindString": "Parameter",
                                  "flags": {},
                                  "type": {
                                    "type": "reference",
                                    "typeArguments": [
                                      {
                                        "type": "intrinsic",
                                        "name": "any"
                                      }
                                    ],
                                    "name": "IBlockData"
                                  }
                                }
                              ],
                              "type": {
                                "type": "intrinsic",
                                "name": "void"
                              }
                            }
                          ]
                        }
                      }
                    },
                    {
                      "id": 16,
                      "name": "setMode",
                      "kind": 1024,
                      "kindString": "Property",
                      "flags": {},
                      "type": {
                        "type": "reflection",
                        "declaration": {
                          "id": 17,
                          "name": "__type",
                          "kind": 65536,
                          "kindString": "Type literal",
                          "flags": {},
                          "signatures": [
                            {
                              "id": 18,
                              "name": "__type",
                              "kind": 4096,
                              "kindString": "Call signature",
                              "flags": {},
                              "parameters": [
                                {
                                  "id": 19,
                                  "name": "mode",
                                  "kind": 32768,
                                  "kindString": "Parameter",
                                  "flags": {},
                                  "type": {
                                    "type": "reference",
                                    "name": "SbMode"
                                  }
                                }
                              ],
                              "type": {
                                "type": "intrinsic",
                                "name": "void"
                              }
                            }
                          ]
                        }
                      }
                    }
                  ],
                  "groups": [
                    {
                      "title": "Properties",
                      "kind": 1024,
                      "children": [
                        6,
                        13,
                        9,
                        16
                      ]
                    }
                  ]
                }
              }
            ],
            "qualifiedName": "Promise",
            "package": "typescript",
            "name": "Promise"
          }
        }
      ]
    }
  ],
  "groups": [
    {
      "title": "Functions",
      "kind": 64,
      "children": [
        1
      ]
    }
  ],
  "sources": [
    {
      "fileName": "index.ts",
      "line": 1,
      "character": 0
    }
  ]
}