From b9421f05a62692c2b87cdb558fb2676c22e7f61c Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Fri, 19 Apr 2024 13:08:59 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- assets/navigation.js | 2 +- assets/search.js | 2 +- functions/createFactory.html | 2 +- functions/createNode.html | 2 +- functions/createServer.html | 2 +- interfaces/CircuitRelayHopOptions.html | 3 --- interfaces/CircuitRelayOptions.html | 3 --- interfaces/ExperimentalOptions.html | 3 --- interfaces/Factory.html | 12 ++++++------ interfaces/InitOptions.html | 8 -------- interfaces/KuboEd25519Init.html | 8 ++++---- interfaces/KuboInfo.html | 4 ++-- interfaces/KuboInit.html | 6 +++--- interfaces/KuboNode.html | 14 +++++++------- interfaces/KuboOptions.html | 26 +++++++++++++------------- interfaces/KuboRSAInit.html | 8 ++++---- interfaces/KuboStartOptions.html | 4 ++-- interfaces/Node.html | 14 +++++++------- interfaces/NodeOptions.html | 20 ++++++++++---------- interfaces/NodeOptionsOverrides.html | 4 ++-- interfaces/PreloadOptions.html | 3 --- interfaces/SpawnOptions.html | 4 ++-- modules.html | 7 +------ types/KuboInitOptions.html | 2 +- types/NodeType.html | 2 +- 25 files changed, 70 insertions(+), 95 deletions(-) delete mode 100644 interfaces/CircuitRelayHopOptions.html delete mode 100644 interfaces/CircuitRelayOptions.html delete mode 100644 interfaces/ExperimentalOptions.html delete mode 100644 interfaces/InitOptions.html delete mode 100644 interfaces/PreloadOptions.html diff --git a/assets/navigation.js b/assets/navigation.js index 21d3caec..535e5125 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43UTUvDQBAG4P+y52BtMJXmJlKxCFYab+JhTSZ0Md1dppPaIP53iVbJx2Z2r33ffTqZLHn5FAQnEqm4VZjXirZQyebe2I0lZfRBRMJK2olUKE2ApczhMHNXL3a0r0Qk3pUuRBoni6/IiYfKAezqZAHVHjTJimMdPY69kzkZbJzUOeOOr7UibppOzjEP9ZtZFXGSzJftCSc16Pi4tS7NpNOGfoAZJGSCR1PAJNCGPoBbbCf3Mdvshn2Wc+5jMpLIvuthiQMnd+PbS5tzQ3TyQGZzBERVgNf7L3LwE0JlZMGN2K9wWGblh+aobiHkPo8samznRruly+X1PIkHy3tuLAyZv99953MESTD68pS1zn/+f9Yr9LXF1Qjq36WhMr5QDiIDPAJOI7/5iHn9BkCzse5TBgAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43TUW+CMBAH8O9yz2ROMlzkzYeZmCUzkb2ZPVQ4YqNrm3rqyLLvbtiYAUp7vPK//ri21+03EH4RpLAUOWlbQQRG0B5SkIrQliLH06TJHvb0eYQIDlIVkMbJ7Ce6L3897/RLESfJdL5SkgaZXg3HrVSpvU4d8kCgkTEdvOkCvUAdcsDakNTq5DWanGM22SK4lybnmIyEJa6ldlEI9J4Ndy51HmqilY9k1he0VhbIevfCEJwZcVWhBtsFY0bQsagyrSEclh7nz9Mk7u33vTLYZ/6/c+tzi4LQeeXlWeW//590Crra7MmButffV9wZGCAytBe0fuQvd5iPGynqt4W0BAAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index 48075986..858e0c29 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VcW2/byA7+L8qrmnpuuuRtcbCLLYqzu2gX58UIDhRbaYQ6kiDL6QZB//vB6GKREjmS5ZwnoxXJj8OP5Fw0yptXFT+O3t32zfue5XvvLtC+lyfPqXfn7ao0qdPfkl1dVK+e752qg3fnPZ7yXZ0V+fEjen77VD8fPN/bHZLjMT16d57302eN/lHsU9aifeg0JzdxKIw827QKf7+Wg8X6tUyPH/v/dtsyAbJztpHldVo9JrvOkNOI2MhhhEmZOY3cJGX2QWBTvlcmVZrXvROM6aJs4uQ23wkth5AbHZ0hsvyxcNu3EquNZ/Wc8UbictPHOqlmbPcia4wX5ZztRuJy07tDmuSnGeuD0DIAkNOf8qz+k08b8Hh5hpfJcZGxm06Qdhp6xgA9ZPUyoE5wNVBy+FZUWf30vAgNSq+GTJ/L+vVLWpLVNoGE0qshy6p4zA7pQu4G4SvCeih+/JH+WBjVs/AVI8xekjr9nL4uHCMQvwQUVthfVXookr2jyLDE8jpL8+ThkO4XmrwZxOmhjBzlONvvq7TRXggLFS4EhmH89Z8yrbLnNK+TgyOWhNjygB6fkmqf5d8uMXwDlOjhUZ4zDmRlfvzr9HA8PVzkAlJb4wQM9L+yanfK6i/pIXn9vSgdsaYl3yV/HaZn85gZAJfPuzp7IZd1Lh/OWitd4AK+MNr/r1CvjvNMkJ/o9REL/eRYLblhx+t1R0DB4+WBrOE+wmHsphPkF2QzIavTI7texUCt4GqgfXYsi6OlehEcEl8Nmub7ssjyZSMEwlcAvizEerkGJqm+Lcq1m05wNdBjUe3Sz9nh8Hf2nBanZYEklFY74Nqr4clpbss2A+TcueGZeHYDt7hf/PmSVlW2p1c5lNzyDvL99MDuoEmrN53G7LAGp+nxfS2TH7mjIcLny8dTpc9FTfaOib2bsyw9FuQgPYbxcROAW3LShLftFm7O0k0vRbvc++Pavs9C9FJLIVD8d0VeV8XhkFYkqRgIya6Cc5wxIahBbh2MqwAxEJBcCjU5cPyaVi9pxR45to8XHxR+Pj0Un5j+2D+7YO3mOglA5hYcA5xdW3EGgLFmDwDmoHZF/piRey0MdJZbB8NNyRjEOR8TEGO6f91LY0TsYh2IXHBa7Dp5oqwuOH0a+7s27ybQdPrVx/2H7Pghy5/SKqubDcWlrsxl5cQTMjnfwRF3zk7cIFL3HZxwZfQ0HcaJvc6Bcb5/+fqLK9e7x++Y59Diwhzvfbzw9HiC5jw9XgA0W0gIbV0RzbgwV0DIg1XFM+OAu3AQ/IqimQF3FQzOq0uLZQo8fvnYzx3jdXf7DnL09KIVxle73XEs58cyy4uxeHw8ZDm5pieN3gwKfJEgd1edf9LYCw4/l8JXaVn8cqqLf2ffqoTe09A+TBWvc8SVsFP02bULAzlOqJlcerezsrEx91kZ9IzZZVXlbhFOK3cJzGjCILdyE5hWbjVM5ZgpJll3DRB3xDjlZ3zEONcWrzpynMAzR45XOuE6gpy4QB5BXu0AeSRJYL+8J6yrt7jbypXAS44sJ044jyyvdIg7wpw4MTnCvBKYPdKcIE+PNC+Hnp5M0Fd4+mcXXPTIyDdKyNBNK+TaWD8WHMBLWh2zgu26A8gguA6oTNPq05LB9HLrYJ5PhzqzL8QdJxI9FJJdB8dcNcM4rdA6ANdUNSDMzlMjiHHCcvfu+mdX371DhiYBmau4lTfyMCh1XHoh8KJ7ehi1k3ovSL6dOm7wXQPpbKSum33XgdJvs8eYo3fY10A6bgFiVOom4DLge9/L8n36j3f3dm67d568Vbex53uPWXrY23vArUe+tyue7WUS77579p/UnrFbiVbk48bztxtfy1sdmft7f9trNA+a/2jEhOdvBSUmkJj0/K2kxCQSU56/VZSYQmLa87faV/p2IyQS00jMeP7WUGIGiQWevw18Fd6qMERiARILPX8b+krc6jhGYiESizx/G1FiERKLPX8bU6AxDq+NtthQgmJERMMETQXmQtiYC5INgekQNuxCkeiYEWEjL0hOBCZF2OALQ0VIYF6Ejb8ISElMjbAUiJAcEWZHWBZEREpigoQlQsSkJOZIWiLkhhq7xBxJS4QkOZKjemkKhq4YzJG0REiyaCTmSFoipKbYlJgjaYmQhrSJOZIBP3bMkbREyIC0iTmSlghJsikxRzLm0TFHquGI5F1hjlTDEcm7whwpS4Qia1ON2lrT1wQpiTlSlgglSUnMkbJEKLI2FeZIWSIUybvCHClLhDK+DG8jieOpMEfKEqHIrqkwRyrm+qbCFOkN1zk1ZkhbGhSZHxozpBuGSNY1Zkg3DJGs69Hc00w+5MyoMUPa0qDJateYIW1p0GS1a8yQtjRosto1ZkhbGrQmJTFDOubmSY0ZMpYHTbYFgykylgdNFrvBFBnLgybJNJgio9iJw2CKjGYnDjNaITQUReQaAVNkArY0DKbINBSRqWQwRSZiJ02DKTIxP3bMUbBhxx5gjgLBjj3AHAWSHXuAOQosEYYsjgBzFPALhgBzFBh2ERKMFnIBG6UAcxSEfJQwR0HERwlzFMR8lDBHoSXCkI0hxByFlghDNoYQcxRaIgzZGELMUajYZUCIOQotEYZsISHmKDTs2EPMUWiJMGQPCUfr7ZCdXkPMUWiJMGS3CTFHYdPqyG4TYo6ihqOIQo8wR5FgJ/cIcxRJdnKPMEeRYif3CHMUaXZyjzBHEc9RhDmKAnZyjzBHEbspika7In5bhBmKGobI7hlhhmJLQ0D2mhgzFFsaArLeYsxQbGkIyHqLMUOxpSEg6y3GDMXsbjXGBMWGTbkYExQ3W1ayMGNMUByy4JigOOIWAfFo4xpz2+V4vHXdcMnRPoKigkuP9hEUldzOuX0ERZVj89yS1JyavKRVne4/tacn2+35k5I377/dkYo8H2i+eTL07t5+/hyOUOy/rG3woRTQFEBTcJrDdZhBU+hBU2gr63sman8DzVo6FD9y+5EdMBQCQ6zz9tB00AHYHXTc/7IWmtdNgwllBhsq7PwPOv9l9xu3v6FpfyPDGG9eyQ62DRhSGLM6NXJIKBAH1TnAAe7ar1Qq+5XKU1Gej3cBs2B8cokZygYYh4w4G+3tYkAOGIjm6DifJIIAbEAANm0AbCEwBrprPAA3GvRNx1ggul/We3hlGdiCGcbqNpd3H/sr44M2GMjGqZs3rx5ACEAEnIrH7kIx8Bj0AMMpw1fdoBQkKIWujiLJmGjuj7WvXIDfINlEF3rT5bDpiigIOIv9h2Ag8UAEZZcKsitOyRXU8BIdDA3kouqrmEup5k040AU5oDrwiOtsKfgAkqokEGLJhZbIJA0yQnNV3LzE/p4dDnX/EhsMAqSF6tpzxDHRfBcHnAYFpbhEbt/xDEoAr4tZzBHWvqsZVGHXbFVVlztR2LcD3o2sJuIuYEVxVWGveJXdFS8wekC/7Koi5FKn/YYGhB2ETnN8W6W0vQ47DoWOQTVzPdTqj8NvgGLEBb5VHCGC6BuXx0ykDYh0yLFk9cc9LwBxjrnMtIoUKOg7oUu3OibjARvQYwIXr83rPQoc1HTI5RZ8zQ7GDNpSzGGPAwVbmUOF6j4gKRTnKdAF37wAeJAg2mWkvW4H0EEdMWrnC54gumC4IatHsALSuC1a3TWRmJvHyeFqaIjL5/YvjIB2A8YqOKftJY8MTXcBUItZtZEOSN+Y9a/90wdUYwQpIbg+0f2Biu8pmpME6G2Ci+lwyRsogrlBdJOD6Tpr0M3yAdfs+m/7AEMgApqbl8crFQOcjzrMmJtYrXJyqovn/t4tsAO6VsiC2wuhQAeMP+QCN/y9B1BBoBYkV/vdh4QgPiCrNNccGy0iPxTID81CthcfBi0Y3K74uhhHUT+Dc62jvdEw2AIOxL0uVxvtDVLgPZiMVLcOjTjgcb9SIK9UtxMMubQ83wwDlQnAYxL03vfKrEyblne3vf/5838ib+hDCE0AAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA61b34+jSA7+X8gr05P6Cem3fbiTRqvdPe2s7iVqrdIJmUGTBERI741a/b+fCirBBrugST9FPdj+bH+2q6hiXqOq+OccPa5fox/5aRc9Wh1Hp80xix6jbZVt6uzfm21dVD+jOLpUh+gx2l9O2zovTufP6PnD9/p4iOJoe9icz9k5eoyit5g1+nuxy1iL7mHQnFyuEmHkzaZT+Otn2Vmsf5bZ+fP1n8O2jEV2bjbyU51V+83WGwoaEUvZRbgp86CRxabMPwlsKo7KTZWd6qsTjOmibPIUNu+FpkPIpU5vEPlpX4TtO4nZxvN6zHgj8X7T53pTjdi+iswxXpRjthuJ95veHrLN6TJivROaBtCr6T/CZeMfT6/wGvZawNjCC/JOXz3jgLIzyykGagVnA+3yc1mcN8+HaXEh8dmg2WlXFvlpWoRA+A7Al4lYL/fAbKpvk2pt4QVnA+2Lapv9mh8Of+XHrLhMSyShNNuB0DxDoKNjbQQoON0Q0viQG0Ix8+KPl6yq8l02RuZNbvoE+XF5ZlcZ0urCa4yG1TlNx/e13PxzCgxE+Hx6PFV2LGpydgzsLW6ydCzIQTqG/pYMwE3ZjeGlzcGNWVpcpWiXr/6ElrhRiKvUVAiU/21xqqvicMgqklQMhGRnwQX2YQiqk5sHE2pADAQkp0INNuVfs+olq9hteft48mb618tz8YWZj9dn0xssO5b1zz+zkpwayNwCitK5uLnGgJVVsc8PdNoxFpCcB7UtTvv82zjQTW4eDLckY5DgekxA9On+104aI1Yh1oHIO96oDt+KKq+/H6daXUANPhzo79y6G0DT5Vefd5/y86f89D2r8jrbzXBlrCoHnpDF+QGOhGt24AZRuh/gRKiih+XQL+x5DvTr/c+vv4Rq3T/+wDqHFifW+NVHBvI5r9k0IjQvOBtotJEQ2rwmGnFhrIGQB7OaZ8SBcOMg+BlNMwIeahhcV+9tliFw/4Duunb0993tOV3v6bt2GF/d605gO9+Xmd6MxX5/yE/knp40uugU+CZB7nIvleXp/J/L8/nyPB0b6dwHX2Vl8culLn7Lv1Ub+p2G9mGoeJ8joYIdoo/uXRjIfkGN1NKHnZX1jYXPyqBnzFtWVW4n4bRy74HpLRjkq9wAppWbDVMFVopB1d0DxB0xDvnpHzGOjcW7jhwH8MyR451OhI4gBy6QR5B3O0AeSRLYLx8JG5ot4bFyJ/CUI8uBE8Ejyzsd4o4wB04MjjDvBGaPNAfIwyPN90MPTyboa67rs+kDvsx3o4YWrVDoxXpfcAAvWXXOC3bqdiCd4DygMsuqL1OCucrNgzleDnW+2e3oozoMhWTnwTHXsRinFZoHEFqqOoTRdaoH0S9Y7m76+uzu+2lkaJCQsY6beWuNQanj0ncCT7rLxqhe6qMg+XEauOW+BzI4SEO33/eB0jfifczerfg9kIGbcoxK3ZZPA36Ko/y0y/4XPb7exu5jJB/UwyqKo32eHXbuW5nWozjaFsejM/Hkn/03c2fsTqIV+byM4vUy1ssHlcinp3h91WgeNP/QiIkoXgtKTCAxGcVrSYlJJKaieK0oMYXEdBSvdazEQ7paITGNxEwUrw0lZpCYjeK1jZV5kFYjMYvEkiheJ7FcPajUIrEEiaVRvE4psRSJraJ4vaJAVzi9LttiSQmKHhENEzQVmAvhci4kaRPTIVzahSIlMSPCZV5oUhKTIlzyhSElMS/C5V+QzAhMjXAUiCSW5iFZplgSsyMcCyIlbWKCxIrjW2CK5JJjXGKGZMPQiuyCXrc07UJ2n8QMSUeDJFmXmCHpaJB0D2KGpKNBkm0oMUPS0SA1KYkZko4GaUhJzJB0NEhLSmKG5Irrb4kZUo4HmZBzBVOkHA8yJSUxRaqhiCRT9WZaM9SWlJ8KU6QcD0qQkpgi5XhQkpTEFCnLtobCFCnHg6KnL6ZIOR4U2ewKU6RWfOyYI71kY9eYIy3Y2DXmSEs2do050g1HZHnq3tKj2dg15kg3HJGFrDFH2rJZ0pgjnfBZwhzplM8S5kiv+CxhjkzDEdlHBnNkGo7IPjKYI+OIUGQfGcyRcURocigazJFp9gfkUDS9HYJhYzeYI+OI0OT4NJgjk7DLq8EcGUeEJjvOYI6MI0KTg9ZgjqwjQpPLq8UcWcEu7hZzZCW7uFvMkVXs4m4xR1azi7vFHFmeI9vbyFl2cbeYI8tu5iymyLLbOYsZsg1DZLdbzFDSMER2UYIZShwNmuyiBDOUOBo02UUJZihxNBiyixLMUMLushNMUGLYkkswQYljwZCNmfQ22wkLjglKUm4TkGCCkhW3zU8wP+mSq40U05MKdquP2Uklt9lPMTmpYnf7aUtO85b3klV1tvvSvu2t1/Du/TX6278Fqtshxmuk0ujx9S2OtHa/b93bn/vLoTRHJp0uUNWtZnL9TTgLzWFzZ0IknQ2RtMrKejek/121v8a0v9YwxpsLGeAe8M+sWJ0aOaQsCIoD8h/ydVrSdFqSi/320g7CX4Lwl214qeL0/YU5cFYC8nx2tPC/KW+m+zgQhAACl6xu85nc/vpxZqcN4lgGdU/NIR/IAEhAUPHsP90DHqcgek4ZXioBVFAawteslYyJ5kuN9nATpB5ErJQvXF+o2nKWbtdLwBVQOuJa4VwJNHdEQBdwJnzXWK55CdakApxzxd5czfzID4f6ejUDHAAUCD89LBd9ewrZKQPnve8J16XtaWKnCqaGHxrC5976v1OuDN13BKX/jgDMCkCn4bLffqAN0geUJFc9Tilrv7XqR6FA+hU3NZx+P3Mapo7LWauIEeUKIIY8doq3s2rgMUi84TLs9PttbkCfJ1yBOEUCVIMpZ0K61XkzSDHoLh3itTk7piIGFW64IQPvcEDMoDwSDrufKFgSARXCUwFHKecp0AUfVAMjoEBkyEj7LQeoLKDHqN2+HgLRAjjD6g1jBaz6kSl9/yfc0kWGK0E9K66e3WWgu9wEFQncTji3y54OnFks1O2TPJAjwKvya5X2ewXNTY3r/8AAoUKGuDWiv8ppkGjrMRNuoXDKm0tdHK9fRwE7IAbDgrvPdoAOaAXDser/1wYIE6zskhsWjRZRVhK4Kbn287dMnRaYEH4JlD5V1v+dcp3U3h51pkBd+XpOufJqP9YBnQvSJfyGxHK4/e4VoDiE33YbrrZul/CAK5CDhAR9iqMyL7NmADyun97e/g/F5YIAlz0AAA=="; \ No newline at end of file diff --git a/functions/createFactory.html b/functions/createFactory.html index fce48a5d..596bf498 100644 --- a/functions/createFactory.html +++ b/functions/createFactory.html @@ -1,2 +1,2 @@ createFactory | ipfsd-ctl

Function createFactory

Settings

Member Visibility

Theme

\ No newline at end of file +

Parameters

Returns Factory<KuboNode>

  • createFactory(options?, overrides?): Factory<Node>

  • Parameters

    Returns Factory<Node>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/createNode.html b/functions/createNode.html index f44d3e9f..610d863f 100644 --- a/functions/createNode.html +++ b/functions/createNode.html @@ -1,2 +1,2 @@ createNode | ipfsd-ctl

    Function createNode

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<KuboNode>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/createServer.html b/functions/createServer.html index b43adbed..89469ece 100644 --- a/functions/createServer.html +++ b/functions/createServer.html @@ -1,2 +1,2 @@ createServer | ipfsd-ctl

    Function createServer

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Server

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/CircuitRelayHopOptions.html b/interfaces/CircuitRelayHopOptions.html deleted file mode 100644 index 6e2861c6..00000000 --- a/interfaces/CircuitRelayHopOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -CircuitRelayHopOptions | ipfsd-ctl

    Interface CircuitRelayHopOptions

    interface CircuitRelayHopOptions {
        active: boolean;
        enabled: boolean;
    }

    Properties

    active -enabled -

    Properties

    active

    active: boolean

    enabled

    enabled: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    activeenabled
    \ No newline at end of file diff --git a/interfaces/CircuitRelayOptions.html b/interfaces/CircuitRelayOptions.html deleted file mode 100644 index 72a2b793..00000000 --- a/interfaces/CircuitRelayOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -CircuitRelayOptions | ipfsd-ctl

    Interface CircuitRelayOptions

    interface CircuitRelayOptions {
        enabled: boolean;
        hop: CircuitRelayHopOptions;
    }

    Properties

    enabled -hop -

    Properties

    enabled

    enabled: boolean

    hop

    hop: CircuitRelayHopOptions

    Settings

    Member Visibility

    Theme

    On This Page

    enabledhop
    \ No newline at end of file diff --git a/interfaces/ExperimentalOptions.html b/interfaces/ExperimentalOptions.html deleted file mode 100644 index b88238ab..00000000 --- a/interfaces/ExperimentalOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -ExperimentalOptions | ipfsd-ctl

    Interface ExperimentalOptions

    interface ExperimentalOptions {
        ipnsPubsub?: boolean;
        sharding?: boolean;
    }

    Properties

    ipnsPubsub? -sharding? -

    Properties

    Optional ipnsPubsub

    ipnsPubsub?: boolean

    Optional sharding

    sharding?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    ipnsPubsubsharding
    \ No newline at end of file diff --git a/interfaces/Factory.html b/interfaces/Factory.html index 8ee905f2..45d62a45 100644 --- a/interfaces/Factory.html +++ b/interfaces/Factory.html @@ -1,11 +1,11 @@ -Factory | ipfsd-ctl

    Interface Factory<DefaultNode>

    interface Factory<DefaultNode> {
        controllers: Node<unknown, NodeOptions<unknown, unknown>, Record<string, any>, unknown, unknown, unknown, unknown>[];
        options: NodeOptions<unknown, unknown>;
        overrides: NodeOptionsOverrides;
        clean(): Promise<void>;
        spawn(options?): Promise<KuboNode>;
        spawn(options?): Promise<DefaultNode>;
    }

    Type Parameters

    Properties

    controllers +Factory | ipfsd-ctl

    Interface Factory<DefaultNode>

    interface Factory<DefaultNode> {
        controllers: Node<unknown, NodeOptions<unknown, unknown>, Record<string, any>, unknown, unknown, unknown, unknown>[];
        options: NodeOptions<unknown, unknown>;
        overrides: NodeOptionsOverrides;
        clean(): Promise<void>;
        spawn(options?): Promise<KuboNode>;
        spawn(options?): Promise<DefaultNode>;
    }

    Type Parameters

    Properties

    controllers options overrides

    Methods

    clean spawn

    Properties

    controllers

    controllers: Node<unknown, NodeOptions<unknown, unknown>, Record<string, any>, unknown, unknown, unknown, unknown>[]

    The previously created nodes that are still running

    -

    options

    options: NodeOptions<unknown, unknown>

    The default options that will be applied to all nodes

    -

    overrides

    overrides: NodeOptionsOverrides

    Config overrides that will be applied to specific node types

    -

    Methods

    clean

    spawn

    Settings

    Member Visibility

    Theme

    On This Page

    controllersoptionsoverridescleanspawn
    \ No newline at end of file +

    options

    options: NodeOptions<unknown, unknown>

    The default options that will be applied to all nodes

    +

    overrides

    overrides: NodeOptionsOverrides

    Config overrides that will be applied to specific node types

    +

    Methods

    clean

    spawn

    Settings

    Member Visibility

    Theme

    On This Page

    controllersoptionsoverridescleanspawn
    \ No newline at end of file diff --git a/interfaces/InitOptions.html b/interfaces/InitOptions.html deleted file mode 100644 index 93ab31c3..00000000 --- a/interfaces/InitOptions.html +++ /dev/null @@ -1,8 +0,0 @@ -InitOptions | ipfsd-ctl

    Interface InitOptions

    interface InitOptions {
        algorithm?: string;
        allowNew?: boolean;
        bits?: number;
        emptyRepo?: boolean;
        pass?: string;
        privateKey?: string;
        profiles?: string[];
    }

    Properties

    algorithm? -allowNew? -bits? -emptyRepo? -pass? -privateKey? -profiles? -

    Properties

    Optional algorithm

    algorithm?: string

    Optional allowNew

    allowNew?: boolean

    Optional bits

    bits?: number

    Optional emptyRepo

    emptyRepo?: boolean

    Optional pass

    pass?: string

    Optional privateKey

    privateKey?: string

    Optional profiles

    profiles?: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    algorithmallowNewbitsemptyRepopassprivateKeyprofiles
    \ No newline at end of file diff --git a/interfaces/KuboEd25519Init.html b/interfaces/KuboEd25519Init.html index 20928028..3b56eee1 100644 --- a/interfaces/KuboEd25519Init.html +++ b/interfaces/KuboEd25519Init.html @@ -1,8 +1,8 @@ -KuboEd25519Init | ipfsd-ctl

    Interface KuboEd25519Init

    interface KuboEd25519Init {
        algorithm?: "ed25519";
        args?: string[];
        config?: Record<string, any>;
        emptyRepo?: boolean;
        profiles?: string[];
    }

    Hierarchy (view full)

    Properties

    algorithm? +KuboEd25519Init | ipfsd-ctl

    Interface KuboEd25519Init

    interface KuboEd25519Init {
        algorithm?: "ed25519";
        args?: string[];
        config?: Record<string, any>;
        emptyRepo?: boolean;
        profiles?: string[];
    }

    Hierarchy (view full)

    Properties

    algorithm? args? config? emptyRepo? profiles? -

    Properties

    Optional algorithm

    algorithm?: "ed25519"

    Optional args

    args?: string[]

    Extra CLI args used to invoke kubo init

    -

    Optional config

    config?: Record<string, any>

    JSON config directives to patch the config file with

    -

    Optional emptyRepo

    emptyRepo?: boolean

    Optional profiles

    profiles?: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    algorithmargsconfigemptyRepoprofiles
    \ No newline at end of file +

    Properties

    Optional algorithm

    algorithm?: "ed25519"

    Optional args

    args?: string[]

    Extra CLI args used to invoke kubo init

    +

    Optional config

    config?: Record<string, any>

    JSON config directives to patch the config file with

    +

    Optional emptyRepo

    emptyRepo?: boolean

    Optional profiles

    profiles?: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    algorithmargsconfigemptyRepoprofiles
    \ No newline at end of file diff --git a/interfaces/KuboInfo.html b/interfaces/KuboInfo.html index 83a9f642..ad693f0c 100644 --- a/interfaces/KuboInfo.html +++ b/interfaces/KuboInfo.html @@ -1,7 +1,7 @@ -KuboInfo | ipfsd-ctl

    Interface KuboInfo

    interface KuboInfo {
        api?: string;
        multiaddrs: string[];
        peerId?: string;
        pid?: number;
        repo: string;
        version?: string;
    }

    Properties

    api? +KuboInfo | ipfsd-ctl

    Interface KuboInfo

    interface KuboInfo {
        api?: string;
        multiaddrs: string[];
        peerId?: string;
        pid?: number;
        repo: string;
        version?: string;
    }

    Properties

    api? multiaddrs peerId? pid? repo version? -

    Properties

    Optional api

    api?: string

    multiaddrs

    multiaddrs: string[]

    Optional peerId

    peerId?: string

    Optional pid

    pid?: number

    repo

    repo: string

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    apimultiaddrspeerIdpidrepoversion
    \ No newline at end of file +

    Properties

    Optional api

    api?: string

    multiaddrs

    multiaddrs: string[]

    Optional peerId

    peerId?: string

    Optional pid

    pid?: number

    repo

    repo: string

    Optional version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    apimultiaddrspeerIdpidrepoversion
    \ No newline at end of file diff --git a/interfaces/KuboInit.html b/interfaces/KuboInit.html index 53e063d0..ff783451 100644 --- a/interfaces/KuboInit.html +++ b/interfaces/KuboInit.html @@ -1,7 +1,7 @@ -KuboInit | ipfsd-ctl

    Interface KuboInit

    interface KuboInit {
        args?: string[];
        config?: Record<string, any>;
        emptyRepo?: boolean;
        profiles?: string[];
    }

    Hierarchy (view full)

    Properties

    args? +KuboInit | ipfsd-ctl

    Interface KuboInit

    interface KuboInit {
        args?: string[];
        config?: Record<string, any>;
        emptyRepo?: boolean;
        profiles?: string[];
    }

    Hierarchy (view full)

    Properties

    args? config? emptyRepo? profiles?

    Properties

    Optional args

    args?: string[]

    Extra CLI args used to invoke kubo init

    -

    Optional config

    config?: Record<string, any>

    JSON config directives to patch the config file with

    -

    Optional emptyRepo

    emptyRepo?: boolean

    Optional profiles

    profiles?: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    argsconfigemptyRepoprofiles
    \ No newline at end of file +

    Optional config

    config?: Record<string, any>

    JSON config directives to patch the config file with

    +

    Optional emptyRepo

    emptyRepo?: boolean

    Optional profiles

    profiles?: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    argsconfigemptyRepoprofiles
    \ No newline at end of file diff --git a/interfaces/KuboNode.html b/interfaces/KuboNode.html index 304d0b8d..24ca6cd0 100644 --- a/interfaces/KuboNode.html +++ b/interfaces/KuboNode.html @@ -1,14 +1,14 @@ -KuboNode | ipfsd-ctl

    Interface KuboNode

    interface KuboNode {
        api: KuboRPCClient;
        options: KuboOptions;
        cleanup(args?): Promise<void>;
        info(): Promise<KuboInfo>;
        init(args?): Promise<void>;
        start(args?): Promise<void>;
        stop(args?): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    api +KuboNode | ipfsd-ctl

    Interface KuboNode

    interface KuboNode {
        api: KuboRPCClient;
        options: KuboOptions;
        cleanup(args?): Promise<void>;
        info(): Promise<KuboInfo>;
        init(args?): Promise<void>;
        start(args?): Promise<void>;
        stop(args?): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    api options

    Methods

    cleanup info init start stop -

    Properties

    api

    api: KuboRPCClient

    options

    options: KuboOptions

    Methods

    cleanup

    • cleanup(args?): Promise<void>

    • Perform any resource cleanup after stopping a disposable node

      -

      Parameters

      • Optional args: unknown

      Returns Promise<void>

    info

    init

    • init(args?): Promise<void>

    • Perform any pre-start tasks such as creating a repo, generating a peer id, +

    Properties

    api

    api: KuboRPCClient

    options

    options: KuboOptions

    Methods

    cleanup

    • cleanup(args?): Promise<void>

    • Perform any resource cleanup after stopping a disposable node

      +

      Parameters

      • Optional args: unknown

      Returns Promise<void>

    info

    init

    start

    stop

    • stop(args?): Promise<void>

    • Stop a node that has previously been started

      -

      Parameters

      • Optional args: unknown

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    apioptionscleanupinfoinitstartstop
    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    start

    stop

    Settings

    Member Visibility

    Theme

    On This Page

    apioptionscleanupinfoinitstartstop
    \ No newline at end of file diff --git a/interfaces/KuboOptions.html b/interfaces/KuboOptions.html index 07ecd74c..8442a65c 100644 --- a/interfaces/KuboOptions.html +++ b/interfaces/KuboOptions.html @@ -1,4 +1,4 @@ -KuboOptions | ipfsd-ctl

    Interface KuboOptions

    interface KuboOptions {
        args?: string[];
        bin?: string;
        disposable?: boolean;
        endpoint?: string;
        env?: Record<string, string>;
        forceKillTimeout?: number;
        init?: boolean | KuboInitOptions;
        repo?: string;
        start?: boolean | KuboStartOptions;
        test?: boolean;
        type: "kubo";
        rpc?(...args): KuboRPCClient;
    }

    Hierarchy (view full)

    Properties

    args? +KuboOptions | ipfsd-ctl

    Interface KuboOptions

    interface KuboOptions {
        args?: string[];
        bin?: string;
        disposable?: boolean;
        endpoint?: string;
        env?: Record<string, string>;
        forceKillTimeout?: number;
        init?: boolean | KuboInitOptions;
        repo?: string;
        start?: boolean | KuboStartOptions;
        test?: boolean;
        type: "kubo";
        rpc?(...args): KuboRPCClient;
    }

    Hierarchy (view full)

    Properties

    args? bin? disposable? endpoint? @@ -11,22 +11,22 @@ type

    Methods

    rpc?

    Properties

    Optional args

    args?: string[]

    Custom cli args

    -

    Optional bin

    bin?: string

    Path to a Kubo executable

    -

    Optional disposable

    disposable?: boolean

    A new repo is created and initialized for each invocation, as well as +

    Optional bin

    bin?: string

    Path to a Kubo executable

    +

    Optional disposable

    disposable?: boolean

    A new repo is created and initialized for each invocation, as well as cleaned up automatically once the process exits

    -

    Optional endpoint

    endpoint?: string

    Where applicable, this endpoint will be used to spawn nodes remotely

    +

    Optional endpoint

    endpoint?: string

    Where applicable, this endpoint will be used to spawn nodes remotely

    Default

    http://127.0.0.1:43134
    -

    Optional env

    env?: Record<string, string>

    Additional environment variables, passed to executing shell. Only applies +

    Optional env

    env?: Record<string, string>

    Additional environment variables, passed to executing shell. Only applies for Daemon controllers

    -

    Optional forceKillTimeout

    forceKillTimeout?: number

    How long to wait before force killing a daemon in ms

    +

    Optional forceKillTimeout

    forceKillTimeout?: number

    How long to wait before force killing a daemon in ms

    Default

    5000
    -

    Optional init

    init?: boolean | KuboInitOptions

    Init options

    -

    Optional repo

    repo?: string

    The path to a repo directory. It will be created during init if it does not +

    Optional init

    init?: boolean | KuboInitOptions

    Init options

    +

    Optional repo

    repo?: string

    The path to a repo directory. It will be created during init if it does not already exist.

    -

    Optional start

    start?: boolean | KuboStartOptions

    Start options

    -

    Optional test

    test?: boolean

    Flag to activate custom config for tests

    -

    type

    type: "kubo"

    The type of controller

    -

    Methods

    Optional rpc

    Settings

    Member Visibility

    Theme

    On This Page

    argsbindisposableendpointenvforceKillTimeoutinitrepostarttesttyperpc
    \ No newline at end of file +

    Optional start

    start?: boolean | KuboStartOptions

    Start options

    +

    Optional test

    test?: boolean

    Flag to activate custom config for tests

    +

    type

    type: "kubo"

    The type of controller

    +

    Methods

    Optional rpc

    Settings

    Member Visibility

    Theme

    On This Page

    argsbindisposableendpointenvforceKillTimeoutinitrepostarttesttyperpc
    \ No newline at end of file diff --git a/interfaces/KuboRSAInit.html b/interfaces/KuboRSAInit.html index 1cf23ad3..d27d7659 100644 --- a/interfaces/KuboRSAInit.html +++ b/interfaces/KuboRSAInit.html @@ -1,9 +1,9 @@ -KuboRSAInit | ipfsd-ctl

    Interface KuboRSAInit

    interface KuboRSAInit {
        algorithm: "rsa";
        args?: string[];
        bits?: number;
        config?: Record<string, any>;
        emptyRepo?: boolean;
        profiles?: string[];
    }

    Hierarchy (view full)

    Properties

    algorithm +KuboRSAInit | ipfsd-ctl

    Interface KuboRSAInit

    interface KuboRSAInit {
        algorithm: "rsa";
        args?: string[];
        bits?: number;
        config?: Record<string, any>;
        emptyRepo?: boolean;
        profiles?: string[];
    }

    Hierarchy (view full)

    Properties

    algorithm args? bits? config? emptyRepo? profiles? -

    Properties

    algorithm

    algorithm: "rsa"

    Optional args

    args?: string[]

    Extra CLI args used to invoke kubo init

    -

    Optional bits

    bits?: number

    Optional config

    config?: Record<string, any>

    JSON config directives to patch the config file with

    -

    Optional emptyRepo

    emptyRepo?: boolean

    Optional profiles

    profiles?: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    algorithmargsbitsconfigemptyRepoprofiles
    \ No newline at end of file +

    Properties

    algorithm

    algorithm: "rsa"

    Optional args

    args?: string[]

    Extra CLI args used to invoke kubo init

    +

    Optional bits

    bits?: number

    Optional config

    config?: Record<string, any>

    JSON config directives to patch the config file with

    +

    Optional emptyRepo

    emptyRepo?: boolean

    Optional profiles

    profiles?: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    algorithmargsbitsconfigemptyRepoprofiles
    \ No newline at end of file diff --git a/interfaces/KuboStartOptions.html b/interfaces/KuboStartOptions.html index 18943f62..bbe1d029 100644 --- a/interfaces/KuboStartOptions.html +++ b/interfaces/KuboStartOptions.html @@ -1,6 +1,6 @@ -KuboStartOptions | ipfsd-ctl

    Interface KuboStartOptions

    interface KuboStartOptions {
        args?: string[];
        ipnsPubsub?: boolean;
        offline?: boolean;
        repoAutoMigrate?: boolean;
    }

    Properties

    args? +KuboStartOptions | ipfsd-ctl

    Interface KuboStartOptions

    interface KuboStartOptions {
        args?: string[];
        ipnsPubsub?: boolean;
        offline?: boolean;
        repoAutoMigrate?: boolean;
    }

    Properties

    args? ipnsPubsub? offline? repoAutoMigrate?

    Properties

    Optional args

    args?: string[]

    Extra CLI args used to invoke kubo daemon

    -

    Optional ipnsPubsub

    ipnsPubsub?: boolean

    Optional offline

    offline?: boolean

    Optional repoAutoMigrate

    repoAutoMigrate?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    argsipnsPubsubofflinerepoAutoMigrate
    \ No newline at end of file +

    Optional ipnsPubsub

    ipnsPubsub?: boolean

    Optional offline

    offline?: boolean

    Optional repoAutoMigrate

    repoAutoMigrate?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    argsipnsPubsubofflinerepoAutoMigrate
    \ No newline at end of file diff --git a/interfaces/Node.html b/interfaces/Node.html index ae34f960..31b850e2 100644 --- a/interfaces/Node.html +++ b/interfaces/Node.html @@ -1,14 +1,14 @@ -Node | ipfsd-ctl

    Interface Node<API, Options, Info, InitArgs, StartArgs, StopArgs, CleanupArgs>

    interface Node<API, Options, Info, InitArgs, StartArgs, StopArgs, CleanupArgs> {
        api: API;
        options: Options;
        cleanup(args?): Promise<void>;
        info(): Promise<Info>;
        init(args?): Promise<void>;
        start(args?): Promise<void>;
        stop(args?): Promise<void>;
    }

    Type Parameters

    • API = unknown
    • Options = NodeOptions
    • Info extends Record<string, any> = Record<string, any>
    • InitArgs = unknown
    • StartArgs = unknown
    • StopArgs = unknown
    • CleanupArgs = unknown

    Hierarchy (view full)

    Properties

    api +Node | ipfsd-ctl

    Interface Node<API, Options, Info, InitArgs, StartArgs, StopArgs, CleanupArgs>

    interface Node<API, Options, Info, InitArgs, StartArgs, StopArgs, CleanupArgs> {
        api: API;
        options: Options;
        cleanup(args?): Promise<void>;
        info(): Promise<Info>;
        init(args?): Promise<void>;
        start(args?): Promise<void>;
        stop(args?): Promise<void>;
    }

    Type Parameters

    • API = unknown
    • Options = NodeOptions
    • Info extends Record<string, any> = Record<string, any>
    • InitArgs = unknown
    • StartArgs = unknown
    • StopArgs = unknown
    • CleanupArgs = unknown

    Hierarchy (view full)

    Properties

    api options

    Methods

    cleanup info init start stop -

    Properties

    api

    api: API

    options

    options: Options

    Methods

    cleanup

    info

    init

    • init(args?): Promise<void>

    • Perform any pre-start tasks such as creating a repo, generating a peer id, +

    Properties

    api

    api: API

    options

    options: Options

    Methods

    cleanup

    info

    init

    • init(args?): Promise<void>

    • Perform any pre-start tasks such as creating a repo, generating a peer id, etc

      -

      Parameters

      Returns Promise<void>

    start

    stop

    Settings

    Member Visibility

    Theme

    On This Page

    apioptionscleanupinfoinitstartstop
    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    start

    stop

    Settings

    Member Visibility

    Theme

    On This Page

    apioptionscleanupinfoinitstartstop
    \ No newline at end of file diff --git a/interfaces/NodeOptions.html b/interfaces/NodeOptions.html index ef4b92b8..82f8adee 100644 --- a/interfaces/NodeOptions.html +++ b/interfaces/NodeOptions.html @@ -1,4 +1,4 @@ -NodeOptions | ipfsd-ctl

    Interface NodeOptions<InitOptions, StartOptions>

    interface NodeOptions<InitOptions, StartOptions> {
        args?: string[];
        disposable?: boolean;
        endpoint?: string;
        env?: Record<string, string>;
        forceKillTimeout?: number;
        init?: InitOptions;
        start?: StartOptions;
        test?: boolean;
        type?: "kubo";
    }

    Type Parameters

    • InitOptions = unknown
    • StartOptions = unknown

    Hierarchy (view full)

    Properties

    args? +NodeOptions | ipfsd-ctl

    Interface NodeOptions<InitOptions, StartOptions>

    interface NodeOptions<InitOptions, StartOptions> {
        args?: string[];
        disposable?: boolean;
        endpoint?: string;
        env?: Record<string, string>;
        forceKillTimeout?: number;
        init?: InitOptions;
        start?: StartOptions;
        test?: boolean;
        type?: "kubo";
    }

    Type Parameters

    • InitOptions = unknown
    • StartOptions = unknown

    Hierarchy (view full)

    Properties

    args? disposable? endpoint? env? @@ -8,18 +8,18 @@ test? type?

    Properties

    Optional args

    args?: string[]

    Custom cli args

    -

    Optional disposable

    disposable?: boolean

    A new repo is created and initialized for each invocation, as well as +

    Optional disposable

    disposable?: boolean

    A new repo is created and initialized for each invocation, as well as cleaned up automatically once the process exits

    -

    Optional endpoint

    endpoint?: string

    Where applicable, this endpoint will be used to spawn nodes remotely

    +

    Optional endpoint

    endpoint?: string

    Where applicable, this endpoint will be used to spawn nodes remotely

    Default

    http://127.0.0.1:43134
    -

    Optional env

    env?: Record<string, string>

    Additional environment variables, passed to executing shell. Only applies +

    Optional env

    env?: Record<string, string>

    Additional environment variables, passed to executing shell. Only applies for Daemon controllers

    -

    Optional forceKillTimeout

    forceKillTimeout?: number

    How long to wait before force killing a daemon in ms

    +

    Optional forceKillTimeout

    forceKillTimeout?: number

    How long to wait before force killing a daemon in ms

    Default

    5000
    -

    Optional init

    init?: InitOptions

    Init options

    -

    Optional start

    start?: StartOptions

    Start options

    -

    Optional test

    test?: boolean

    Flag to activate custom config for tests

    -

    Optional type

    type?: "kubo"

    The type of controller

    -

    Settings

    Member Visibility

    Theme

    On This Page

    argsdisposableendpointenvforceKillTimeoutinitstarttesttype
    \ No newline at end of file +

    Optional init

    init?: InitOptions

    Init options

    +

    Optional start

    start?: StartOptions

    Start options

    +

    Optional test

    test?: boolean

    Flag to activate custom config for tests

    +

    Optional type

    type?: "kubo"

    The type of controller

    +

    Settings

    Member Visibility

    Theme

    On This Page

    argsdisposableendpointenvforceKillTimeoutinitstarttesttype
    \ No newline at end of file diff --git a/interfaces/NodeOptionsOverrides.html b/interfaces/NodeOptionsOverrides.html index 16a65801..7eba2f31 100644 --- a/interfaces/NodeOptionsOverrides.html +++ b/interfaces/NodeOptionsOverrides.html @@ -1,2 +1,2 @@ -NodeOptionsOverrides | ipfsd-ctl

    Interface NodeOptionsOverrides

    interface NodeOptionsOverrides {
        kubo?: KuboOptions;
    }

    Properties

    kubo? -

    Properties

    Optional kubo

    kubo?: KuboOptions

    Settings

    Member Visibility

    Theme

    On This Page

    kubo
    \ No newline at end of file +NodeOptionsOverrides | ipfsd-ctl

    Interface NodeOptionsOverrides

    interface NodeOptionsOverrides {
        kubo?: KuboOptions;
    }

    Properties

    kubo? +

    Properties

    Optional kubo

    kubo?: KuboOptions

    Settings

    Member Visibility

    Theme

    On This Page

    kubo
    \ No newline at end of file diff --git a/interfaces/PreloadOptions.html b/interfaces/PreloadOptions.html deleted file mode 100644 index de0c0a13..00000000 --- a/interfaces/PreloadOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -PreloadOptions | ipfsd-ctl

    Interface PreloadOptions

    interface PreloadOptions {
        addresses?: string[];
        enabled?: boolean;
    }

    Properties

    addresses? -enabled? -

    Properties

    Optional addresses

    addresses?: string[]

    Optional enabled

    enabled?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    addressesenabled
    \ No newline at end of file diff --git a/interfaces/SpawnOptions.html b/interfaces/SpawnOptions.html index eb225ca4..eb6de82c 100644 --- a/interfaces/SpawnOptions.html +++ b/interfaces/SpawnOptions.html @@ -1,3 +1,3 @@ -SpawnOptions | ipfsd-ctl

    Interface SpawnOptions

    interface SpawnOptions {
        remote?: true;
    }

    Properties

    remote? +SpawnOptions | ipfsd-ctl

    Interface SpawnOptions

    interface SpawnOptions {
        remote?: true;
    }

    Properties

    remote?

    Properties

    Optional remote

    remote?: true

    Use remote endpoint to spawn the controllers. Defaults to true when not in node

    -

    Settings

    Member Visibility

    Theme

    On This Page

    remote
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    remote
    \ No newline at end of file diff --git a/modules.html b/modules.html index 7f681caa..63a8c98f 100644 --- a/modules.html +++ b/modules.html @@ -20,11 +20,7 @@

    Example: Create server

    In node.js:

  • disposable- Disposable nodes are useful for tests or other temporary use cases, they create a temporary repo which is deleted automatically when the node is stopped
  • non-disposable - Disposable nodes will not delete their repo when stopped
    • -

    Index

    Interfaces

    CircuitRelayHopOptions -CircuitRelayOptions -ExperimentalOptions -Factory -InitOptions +

    Index

    Interfaces

    Factory KuboEd25519Init KuboInfo KuboInit @@ -35,7 +31,6 @@

    Example: Create server

    In node.js:

    Node NodeOptions NodeOptionsOverrides -PreloadOptions SpawnOptions

    Type Aliases

    KuboInitOptions NodeType diff --git a/types/KuboInitOptions.html b/types/KuboInitOptions.html index 47c3fd99..771c5ccd 100644 --- a/types/KuboInitOptions.html +++ b/types/KuboInitOptions.html @@ -1 +1 @@ -KuboInitOptions | ipfsd-ctl

    Type alias KuboInitOptions

    KuboInitOptions: KuboEd25519Init | KuboRSAInit

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +KuboInitOptions | ipfsd-ctl

    Type alias KuboInitOptions

    KuboInitOptions: KuboEd25519Init | KuboRSAInit

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/NodeType.html b/types/NodeType.html index aa57641d..daa1386f 100644 --- a/types/NodeType.html +++ b/types/NodeType.html @@ -1 +1 @@ -NodeType | ipfsd-ctl

    Type alias NodeType

    NodeType: "kubo"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +NodeType | ipfsd-ctl

    Type alias NodeType

    NodeType: "kubo"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file