@tidy-ui/toaster/jsdoc.json

tidy-ui react component library; 'toaster package

[
    {
        "comment": "/**\n * Toast\n * @interface IToast\n */",
        "meta": {
            "filename": "types.ts",
            "lineno": 7,
            "columnno": 0,
            "path": "/home/runner/work/tidy-ui/tidy-ui/packages/toaster/src",
            "code": {}
        },
        "description": "<p>Toast</p>",
        "kind": "interface",
        "name": "IToast",
        "longname": "IToast",
        "scope": "global"
    },
    {
        "comment": "/**\n   * Id\n * @name IToast#id\n * @optional\n * @type {string}\n */",
        "meta": {
            "filename": "types.ts",
            "lineno": 11,
            "columnno": 0,
            "path": "/home/runner/work/tidy-ui/tidy-ui/packages/toaster/src",
            "code": {}
        },
        "description": "<p>Id</p>",
        "name": "id",
        "tags": [
            {
                "originalTitle": "optional",
                "title": "optional",
                "text": ""
            }
        ],
        "type": {
            "names": [
                "string"
            ]
        },
        "memberof": "IToast",
        "longname": "IToast#id",
        "scope": "instance",
        "kind": "member",
        "optional": true
    },
    {
        "comment": "/**\n   * Item\n * @name IToast#item\n * @optional\n * @type {TToastItem}\n */",
        "meta": {
            "filename": "types.ts",
            "lineno": 17,
            "columnno": 0,
            "path": "/home/runner/work/tidy-ui/tidy-ui/packages/toaster/src",
            "code": {}
        },
        "description": "<p>Item</p>",
        "name": "item",
        "tags": [
            {
                "originalTitle": "optional",
                "title": "optional",
                "text": ""
            }
        ],
        "type": {
            "names": [
                "TToastItem"
            ]
        },
        "memberof": "IToast",
        "longname": "IToast#item",
        "scope": "instance",
        "kind": "member",
        "optional": true
    },
    {
        "comment": "/**\n * Toaster props\n * @interface IToasterProps\n */",
        "meta": {
            "filename": "types.ts",
            "lineno": 23,
            "columnno": 0,
            "path": "/home/runner/work/tidy-ui/tidy-ui/packages/toaster/src",
            "code": {}
        },
        "description": "<p>Toaster props</p>",
        "kind": "interface",
        "name": "IToasterProps",
        "longname": "IToasterProps",
        "scope": "global"
    },
    {
        "comment": "/**\n   * Maximum number of toasts that a toaster can toss at any instant\n * @name IToasterProps#limit\n * @optional\n * @type {number}\n */",
        "meta": {
            "filename": "types.ts",
            "lineno": 27,
            "columnno": 0,
            "path": "/home/runner/work/tidy-ui/tidy-ui/packages/toaster/src",
            "code": {}
        },
        "description": "<p>Maximum number of toasts that a toaster can toss at any instant</p>",
        "name": "limit",
        "tags": [
            {
                "originalTitle": "optional",
                "title": "optional",
                "text": ""
            }
        ],
        "type": {
            "names": [
                "number"
            ]
        },
        "memberof": "IToasterProps",
        "longname": "IToasterProps#limit",
        "scope": "instance",
        "kind": "member",
        "optional": true
    },
    {
        "comment": "/**\n   * Timeout for toasts, in milliseconds\n   *\n   * @default 5000\n * @name IToasterProps#timeout\n * @optional\n * @type {number | 'infinite'}\n */",
        "meta": {
            "filename": "types.ts",
            "lineno": 33,
            "columnno": 0,
            "path": "/home/runner/work/tidy-ui/tidy-ui/packages/toaster/src",
            "code": {}
        },
        "description": "<p>Timeout for toasts, in milliseconds</p>",
        "defaultvalue": "5000",
        "name": "timeout",
        "tags": [
            {
                "originalTitle": "optional",
                "title": "optional",
                "text": ""
            }
        ],
        "type": {
            "names": [
                "number",
                "'infinite'"
            ]
        },
        "memberof": "IToasterProps",
        "longname": "IToasterProps#timeout",
        "scope": "instance",
        "kind": "member",
        "optional": true
    },
    {
        "comment": "",
        "meta": {
            "range": [
                6,
                16
            ],
            "filename": "types.ts",
            "lineno": 1,
            "columnno": 6,
            "path": "/home/runner/work/tidy-ui/tidy-ui/packages/toaster/src",
            "code": {
                "id": "astnode100000003",
                "name": "_____a",
                "type": "Literal",
                "value": 1
            }
        },
        "undocumented": true,
        "name": "_____a",
        "longname": "_____a",
        "kind": "constant",
        "scope": "global",
        "params": []
    },
    {
        "kind": "package",
        "longname": "package:undefined",
        "files": [
            "/home/runner/work/tidy-ui/tidy-ui/packages/toaster/src/types.ts"
        ]
    }
]