sg-templates/misc/sample-jsdoc.json

Templates for SUGOS

{
  "functions": [
    {
      "name": "create",
      "access": "",
      "virtual": false,
      "description": "Create driver instance",
      "parameters": [
        {
          "name": "args",
          "type": "*",
          "description": "",
          "default": "",
          "optional": "",
          "nullable": ""
        }
      ],
      "examples": [],
      "returns": {
        "type": "Driver",
        "description": ""
      }
    }
  ],
  "classes": [
    {
      "name": "Driver",
      "description": "",
      "extends": [],
      "access": "",
      "virtual": true,
      "fires": "",
      "constructor": {
        "name": "Driver",
        "description": "Abstract driver",
        "parameters": [],
        "examples": []
      },
      "functions": [
        {
          "name": "one",
          "access": "",
          "virtual": false,
          "description": "Get single resource from namespace",
          "parameters": [
            {
              "name": "namespace",
              "type": "string",
              "description": "Namespace to work with",
              "default": "",
              "optional": "",
              "nullable": ""
            },
            {
              "name": "id",
              "type": "ClayId",
              "description": "Resource id",
              "default": "",
              "optional": "",
              "nullable": ""
            }
          ],
          "examples": [],
          "returns": {
            "type": "Promise.<ClayEntity>",
            "description": "Found resource"
          }
        },
        {
          "name": "list",
          "access": "",
          "virtual": false,
          "description": "List resource in namespace",
          "parameters": [
            {
              "name": "namespace",
              "type": "string",
              "description": "Namespace to work with",
              "default": "",
              "optional": "",
              "nullable": ""
            },
            {
              "name": "condition",
              "type": "ListCondition",
              "description": "List condition query",
              "default": "{}",
              "optional": true,
              "nullable": ""
            }
          ],
          "examples": [],
          "returns": {
            "type": "Promise.<ClayCollection>",
            "description": "Found resource collection"
          }
        },
        {
          "name": "create",
          "access": "",
          "virtual": false,
          "description": "Create data with namespace",
          "parameters": [
            {
              "name": "namespace",
              "type": "string",
              "description": "Namepath string",
              "default": "",
              "optional": "",
              "nullable": ""
            },
            {
              "name": "attributes",
              "type": "Object",
              "description": "Resource attributes to create",
              "default": "",
              "optional": "",
              "nullable": ""
            }
          ],
          "examples": [],
          "returns": {
            "type": "Promise.<ClayEntity>",
            "description": "Created data"
          }
        },
        {
          "name": "update",
          "access": "",
          "virtual": false,
          "description": "Update data with namespace",
          "parameters": [
            {
              "name": "namespace",
              "type": "string",
              "description": "Namepath string",
              "default": "",
              "optional": "",
              "nullable": ""
            },
            {
              "name": "id",
              "type": "ClayId",
              "description": "Resource id",
              "default": "",
              "optional": "",
              "nullable": ""
            },
            {
              "name": "attributes",
              "type": "Object",
              "description": "Resource attributes to update",
              "default": "",
              "optional": "",
              "nullable": ""
            }
          ],
          "examples": [],
          "returns": {
            "type": "Promise.<ClayEntity>",
            "description": "Updated data"
          }
        },
        {
          "name": "destroy",
          "access": "",
          "virtual": false,
          "description": "Delete data with namespace",
          "parameters": [
            {
              "name": "namespace",
              "type": "string",
              "description": "Namepath string",
              "default": "",
              "optional": "",
              "nullable": ""
            },
            {
              "name": "id",
              "type": "ClayId",
              "description": "Resource id",
              "default": "",
              "optional": "",
              "nullable": ""
            }
          ],
          "examples": [],
          "returns": {
            "type": "Promise.<number>",
            "description": "Destroyed count (0 or 1)"
          }
        },
        {
          "name": "drop",
          "access": "",
          "virtual": false,
          "description": "Drop resource with namespace",
          "parameters": [
            {
              "name": "namespace",
              "type": "string",
              "description": "Namepath string",
              "default": "",
              "optional": "",
              "nullable": ""
            }
          ],
          "examples": [],
          "returns": {
            "type": "Promise.<boolean>",
            "description": "False if there were nothing to drop"
          }
        }
      ]
    }
  ]
}