apeman-service-api/jsdoc.json

Apeman service for API access.

{
  "classes": [
    {
      "name": "ApApiService",
      "description": "",
      "extends": [],
      "access": "",
      "virtual": false,
      "fires": "",
      "constructor": {
        "name": "ApApiService",
        "description": "Service",
        "parameters": [
          {
            "name": "store",
            "type": "Object",
            "description": "Redux store",
            "default": "",
            "optional": "",
            "nullable": ""
          },
          {
            "name": "options",
            "type": "Object",
            "description": "Optional settings",
            "default": "",
            "optional": "",
            "nullable": ""
          }
        ],
        "examples": []
      },
      "functions": [
        {
          "name": "configure",
          "access": "",
          "virtual": false,
          "description": "Configure api",
          "parameters": [
            {
              "name": "url",
              "type": "string",
              "description": "",
              "default": "",
              "optional": "",
              "nullable": ""
            }
          ],
          "examples": []
        },
        {
          "name": "reach",
          "access": "",
          "virtual": false,
          "description": "Test reachability of the API",
          "parameters": [
            {
              "name": "args",
              "type": "",
              "description": "",
              "default": "",
              "optional": "",
              "nullable": ""
            }
          ],
          "examples": [],
          "returns": {
            "type": "*",
            "description": ""
          }
        },
        {
          "name": "use",
          "access": "",
          "virtual": false,
          "description": "Use api",
          "parameters": [
            {
              "name": "name",
              "type": "string",
              "description": "Name of API",
              "default": "",
              "optional": "",
              "nullable": ""
            }
          ],
          "examples": [],
          "returns": {
            "type": "*",
            "description": ""
          }
        },
        {
          "name": "url",
          "access": "",
          "virtual": false,
          "description": "Get url",
          "parameters": [
            {
              "name": "pathname",
              "type": "string",
              "description": "Url path name",
              "default": "",
              "optional": "",
              "nullable": ""
            }
          ],
          "examples": [],
          "returns": {
            "type": "string",
            "description": "- Url"
          }
        }
      ]
    }
  ],
  "functions": [
    {
      "name": "create",
      "access": "",
      "virtual": false,
      "description": "Create the service instance",
      "parameters": [
        {
          "name": "args",
          "type": "*",
          "description": "",
          "default": "",
          "optional": "",
          "nullable": ""
        }
      ],
      "examples": [],
      "returns": {
        "type": "ApApiService",
        "description": ""
      }
    }
  ]
}