From 9c0ffefdb8a995c772ff9bd5e30e8ba45d00fba0 Mon Sep 17 00:00:00 2001 From: Jason Williscroft Date: Thu, 17 Oct 2024 11:27:41 +0800 Subject: [PATCH] chore: release v0.1.3 --- CHANGELOG.md | 7 +++++ docs/assets/search.js | 2 +- docs/documents/CHANGELOG.html | 11 +++++-- .../controlled_proxy.controlledProxy.html | 2 +- docs/index.html | 30 +++++++++++++++++++ ...ntrolled_proxy.ControlledProxyOptions.html | 8 ++--- docs/modules/controlled_proxy.html | 2 +- .../controlled_proxy.ControlledPartial.html | 2 +- ...ontrolled_proxy.DisabledMemberHandler.html | 2 +- .../controlled_proxy.controlProp.html | 2 +- ...olled_proxy.disabledMemberHandlerProp.html | 2 +- package-lock.json | 4 +-- package.json | 2 +- 13 files changed, 60 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ac69bc2..0b987b3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,8 +4,15 @@ All notable changes to this project will be documented in this file. Dates are d Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). +#### [0.1.3](https://github.com/karmaniverous/controlled-proxy/compare/0.1.2...0.1.3) + +- updated readme [`d7807b3`](https://github.com/karmaniverous/controlled-proxy/commit/d7807b3a489e1d869f82fb28cb87bd53867c22a3) + #### [0.1.2](https://github.com/karmaniverous/controlled-proxy/compare/0.1.1...0.1.2) +> 17 October 2024 + +- chore: release v0.1.2 [`817c9dd`](https://github.com/karmaniverous/controlled-proxy/commit/817c9dd7a84178c84c397d20f30037c80b8770de) - updated readme [`8da225a`](https://github.com/karmaniverous/controlled-proxy/commit/8da225a79eaa2f5ede18ddf563e32ee7c0ea9ec4) - added images [`413d9ba`](https://github.com/karmaniverous/controlled-proxy/commit/413d9ba6790d42eda00b33d1ecbf438c43d446ac) diff --git a/docs/assets/search.js b/docs/assets/search.js index b6f5fd1..1581619 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACrVbSY/juBX+L5pLDhwV96VuwSSYCZBk5pRLodCgJbqtjC0ZslzdnUL/94ASKevJol3yJCexaPLj29/jUu9Z23w5Zc8v79nvVV1mz5ppLbFGWW0PLnvOfvrlz//8+a9///XnDGXndp89Z2VTnA+u7k5P42/5rjvsM5QVe3s6uVP2nGXfUUSkI1bR1F3b7Peu/PHYNl+/jZCHpjzv3enpMuBTP+A2LjaKiAv6T+Pk32zbVXY/wnffjkvgVxMWlkPZ0bau7paov5Ai+QKPvwEWt+e66KqmXqBjNuVhKqiQS8Lwo3499muP1FR159qtLe6IZTL1YaoIphfplG5rz/suLPGH6fnhGu9j9CVA75D9l+pkN3tX/sMdNq79xdbl3rX/Kx5S4P8XhjrbfnbdHyZ9gPmR/A/JZFfh4re2OY6Uvtm28mJKu5Ef/rgLzWLKbY0n4sripMdjixDs4tefPvlFH6fghxHggwpblsCivsqloR/VXnLyWsG9oqyqS/c1e37P3lx7qpo6e85oznKToWxbuX3p891ANMqK5uCTWYbGvJa9hmH/ckXXtH7wMPoJZ+gFI6JyTOnrK3qJk/sf+o6IEYbiXCmKCCI54wRRhHNmGGLhy8NXIJwTKpFEOOecIBX6te83DBn/FRIRHH4gxCNTgUiEJBGT9KCIiPi3jI2ISnRsmNCgEZeS2Ii4lCGSU2EQHXBpxKUSkVwzhWjEpRGXRlwWcVnEZaMIIr2MB1aYiA0ZGwqRHBOCWERmEZlHZB6ReUTmo3SjeHmkmUdZ8Egzj8g8IouILCKyiMgiIotRcQG5V31vISRDL0IimjOGhOq/wFDIlaGMPf186udrRGlOjQQz6YCMc461hw4Ng2iusUISeyNTBklvbQoLJD3dVGkkGaI54QzJXtZEIOnpNpgg6QGFoJAkCkhiGXqRaokk/4tfDdPBhqXUva1q2tsLyYVBA8mUDCQzTANdWg7kCDZQ4+cO1CgkNaI51hRJExoKD2iKxA4aGyw2eGyIMFaGrwokqQirAizkmgGueYZeNF7i2v8SKdaBe4NITgQbuPVMXrjFYcjANpYzdr27RwJ15E5H7jQbeNBBmjrwpmUcoEKHDl8zfE0QmCHhS8M3AJoBEEqAAwmIDL0YsSQB/4sXLtVqkAAng945jxLQUQJ6YJwxGvTNB76ljIxzjoxHk0Qh412GEIOMjj0mNAjG4TeCydjybClNEMFs7OPjDDG0IJcCcCm9DWO5xKYM5i2N7s1bER3YoyLo1UT2vC+x3vHUYHh9wyuHEjJw43sIVmEawb6PCU+wiS2C4zhCxhYdW55FyiQihA8tyJgEjClPPRGIsFxwDRhTvQX72GpCJJEk8EGienxy8bNzQ2dWosAyupefWEqKejFiLcSnZFjy2h9CV9C0X4jIoQ9SpQFVpmeeLlFlglYFM2gI32pIvIz2CdcHU2/MStMhmQoe/JoELrytyT5NcBO5EAMXLHKhoiAJ98FrQFEiNlQfApn376FHx5V0HKP9GMO5d+3QY0Kjd24quPfu0EPDYBMBTQQ0MjS8Y8RWjy15sELhowHumRa0t8IwjpCx5U2B9KWHt2Du3ZL4ucabPemdlFNEaE+az9x9LaG8HffFxNBiY4uP48TYJ8eWGlt6RPamwDkiDMcuNi7BxiXYuMRQWfQtERdjcmypsaXHcSMbfGSDj2v4/tA3rsHHNXjUG+GBDWifBtgn8eUh4YtZtf9t8EZFgnP48N6HDq+fXme+hwtfYMhZHiMYLkX6pRZrCkKii7IQCVgoIGRMWDJYttQhUWsZ/dPrpndLyQJ1zJtEH856q+iTFNe9zfStGaFD6dPX62+u7Vz5t6Fuf3nJMvSefQplPIkbjPfvl3L9+T1jQ48cPsZ/vk+q+Of3DPd93/2qOCc5nqJysQx7G4K8/mnXdcfT89PT56rbnTd50RyefrftwdbVm2ub83RrM13vsk9asx59eD2aEFt6PSIBvXztfIopBwhyLQKjpnTETkHEarFxwkqzASAMrwbZOGa3gB2u14IIyiiFWhGrpaqckq4UgBK2FkSXllIBZEJX2388OZh4JlcjSEZw8MAU1oACiJAJIjI69AQX58NHTzwdZYRce3xYoijc6QQFT1L+sBQ4AkxZzlxqtQXY/R4APDDfn85PJZagYRDVIhv7pv4MtbZeFPUUwCQcOxPJUBxhZjox6wn5NkVQCceOhpPGOR7b5thWtpsZdAowjdTOED4OADTdfj5BnISx3KAEAuAUJXe11AERp2DSBnfuGkBJQstpYWyASFNGAoNDmiuIvLNvVdMCl7q5wBKHG2CEZHVYKOw8W5OUkNJqKna2/uz2DfDti/lm98IxIKjHAvazOlEVuwa6QsqXbkA0h0MFrG+SYD6MUXe2qisY80wCZzCbRfE2dee+AmL8hmOtkobaDJCS0rSYZLkbWDPLudz5vWfkSuXLiTSsJNel1cv6x3i/OiHj4gTDmncLgQnccFE68chJWcEeAWvidecFU09cg6/BPPYXGNPAeilaRmV9yKJaZ7uZXepUlOcplNJ20FHJ6mowXDgCo0yVFVNTWSRnwCrGC9gJ5kRO4kMSD2DxKujQXwXt4qXbVAUTo5droKHkSCrbp/eUI1pVV97GYD2TKoxuAJ269lx01Zvbw8omodV0UopSg4JKBZsph7ec/r4uyMWERz7nC30Y+crZJruuC5V3VF2djnv7bSaJ1dudsimAtbDVqSh2z3WyFsfZYgcRUnkoGXvcV3s47mHgUKvrHvf1uK+KqoOmalIVIr/jRduSldRtgJBX11Lbag8L8NWbrO3ezmpvnIoLSfluYUmpUuXGrTycllPbHEDSSO2a7wr8XFzFrJTEb6HU1zA4BTMLNDiF+tnVrrVzX1ntc/2rlqk1rNiPDQiL+SalzyXuboXThcO8oml+P7rOPc33TXR1oHj0qHD1QV2Vz3xu9Wa12kIrXJ05q4Od7VhSpwk32IA2vPrEtKq3rm2hMPWj0bCqt017sFeelTxRSGbWvjSB5Tlfr2L/JKyGKP4CZ62aZhXX6mgD94M6Nf+udGelH18dF4Y6BXKTCgt3y6qD63YNDHVstWwPTVltK2h+6uZtyTLK7AQrtaFIG1zt/IGrbWFZkKLknqpqeHqUOu2+BQA8SKWCU1IkdQM3R6ly4D4nnS9xQYGz1g+bzb9dAciRqVh5a6+vslV7/abompm1s9UVdANivEx5HCRbLBJ6N7E2R189XG3IUpVSUmXDyQEIOSlxJ7foS6cPN51hCQRug1JXD2lGjra1B9e5FtKRcqZ7ptzDwRBKb0a/RZC2mRvz6gLP7xBd21Uw98sUX8G4kqErwMEDXZyKGNA409boUQF9YnVtcWybt6qEB+E3D4tuKW/AmuWb1b5xdU4nptd/2aqzx5XxqF/6aTgffgrXxFvsdCGtLcpCsIIQTRjebCzGbFNIzEoKSF0deMGS4VJZKoNLTl1pMd4wVhJXbLac6YKzknNpCxAwH9H5ZMnhCtoIKyg1fKuodVuHmeJWbDbWOkqkLTl81LC6BAZLhgtrq7ZU281GK6KlYhRTzTEXmG9KhVnBGBDs6rQAlgzX21JuzFZspFJUKY4J49bQgpRugxljpdGAy9V3E2DJcBmujLOWboUrHdFluRWSOUadUwV21rgCXP6nYt0HlwwnHUW5dUpaa82WCmIoLpRxhklLLaFbUgJdssd16V/HP/UvXvI875+tAODHXWEEJgEY+FhqF3gHeGnDnXp9kg5OQ/a3++o/s/uR1bvo1tnyAAJv8hBhoYKESIXzW2/I2uor5tbtnT3Bu7XVsaV1dena+VFkKm0mD7pad2zdydXziwyZKnDoB1Nm606zOwmSeqJ1/zCpdd25rWfMpvbANwR/rrsKmoJK0XTvxcHJQiCSehB2A8JBUlL8TB/GLeLsmvMeHlqkjoLvVRanb4cNvN70z/6Wse6aQPyntCnY5A5JXVcY6g55nTsc97M3HiLFK02i7ACATCnuA3ety2XP3d1Nt3PgBNg8WsZ3O3ggs/4lzzSmwPPKO57BlwRxb4HZgzOZip10aY2kFM51f4E3f4KRCmEfgWv332YRkaQujG4AHcv5CXjqxC0ts/PJfoZxYvWTsXMHCtmUR6dpeLsqOlLPmW5g2P0ZbvJ0SqD3rP7Lzs3OBVbn4C8VfMp35xzyY/7zpergxV6q5kvQ9YqyY3V0+6p22fPL6/fv/wUr+ZyTzj8AAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACrVbS5PjthH+L/QlB1qD92NuLidlpyqJfcplamoLIqERY4lUUdTsbqb2v6dAABSbIiRR65yIgYgP/e5Gg/ORtc3nY/b88pH9UdVl9qyoUgKpPKvN3mbP2c+//vSvX/72j99+yfLs1O6y56xsitPe1t3xafhtte32uyzPip05Hu0xe86yb3lEJANW0dRd2+x2tvzx0DZfvg6Q+6Y87ezx6fzCp/6F67hIS8zP6D8Pi383bVeZ3QDffT3MgV8smNkuzw6mtXU3R/2ZFMFmePwdsLg51UVXNfUMHZMlD1NBuJgThnvrt0O/90BNVXe23ZjihlhGSx+mCiNylk5pN+a068IW303PD5d499GXAL1B9l+ro1nvbPlPu1/b9ldTlzvb/lk8pMD/Lwx1pn2z3XeT7mF+xH8imfQiXPzeNoeB0nfTVk5MaTdyrz/uQpOYcl3jibgyu+jx2MI5Pfv1p09u08cp+GEAuFNh8xKY1Vc59+q92ksuXiq41zyr6tJ+yZ4/snfbHqumzp4zsqIrneXZprK70uU7T3SeFc3eJbMsH/Ja9hpe+7ctuqZ1L/u3n1CWv6AcyxUi5PU1f4mL+x/6iYgRXkUrKUmOc7xikuYkRyuqaU7Dk4Unz9EKE5GLHK0Yw7kM88rNa5pr9+Qixyj8gLFDJjzHERJHTNyD5pjHv0UcRFSs4kCHAYm4BMdBxCW0p53nxOFyznISkYnIyQoTmZOITCIyicg0IlMnA4RxTkkc0MADZXEQkWmkmUZkGpFpRGYRmUWaWaSZDfKNAmYRmYmwF5OBDBaRWUTmEZlHZB6ReUTmg+oiMo8080gzj8g8IouILCKyiMgiIPdG1NsazvIXwXKyojQXvH8Ck8MXJjfM9OuJWy9yQlZEC7CSeGS0Ykg56DCQOVkpJHOhcryiUudC53glEc+lo5tIlUvsVM5oLh3dEvNcOro1wrn09kEgSQSQRLP8xZnSJUnul95CiPcGIVRv9YpoZ3l4xXXuSSbYk0wRCXQp4cnh1FPj1npqZC6djSJFcinjQHk0qcOEQnGA44DEAfXvqkCB4oEkFWFVgIVcU8A1y/IXpea4dr9EblXg3skcc+q5dUwO3Ir4imcbiQm7DI8IjNzpyJ3GngdNwjPwpll8gYcJEZ4yPIPAtPZPjFAc4DjwmFAIDAiBOwUjOicF95PbkyjppcCw1z1jUQoqSkF55iklQefM8y5EZJ6xHCOnL4FljpFzHIwdjWKYk8NIDb/qOMKOO6lwjjEe5khcgakfQVY5YFU4VjGbY1UEMxda9WYusQosEh70qyOLzqdw74DSG2A/cEoiGAd+3BTGPKzD2M1RpxFHaxip4T0dRwQNI8cjoSLHhPgR5EwAzqQj32UEuuJMAc5kb8oupOoQUgQOjOCooz5fOQFqMrEVCbZRvQDpXJ5V86HrMlAl41Ovfx/Egq6RI4v5OUiWAmTpnvvZ9K+DXjnVuU8I0idzSvok7sKqM2mpiE/QnAUPx4EN5xuiTxhMRza4Z4NGNmSUpHuqgKJoHPA+GFLn6X5GkziI72j3jmbMOXmYkXHg7IRw5vzczzhH9287T49zZBhFPjAe5vqqQwsWTJFr1psiWkkneKyG94Y9entwNQ521rFiLsoQt1YLN9e7KiM5Jj151JlsL0jnAn1x4Ud4GJH4nq8v+jk2jPgwEhGZOnNwTFI1TA1bsGELNmzByDCicTO3Poz4MBLDewMbbGCDDXtwFOf4sAcf9uBRd5gHNqCNamCj2JWdmM/m2P4375ISBw9RKsSPXj9OJm6GU1duiElWwwhuhfutZisMjKOf0hAOaCgnRExfIli3UCFtKxGd1Om6d01BA3XURbE+pvVW0acsJ0rC/WhCqC+E+nPAu207W/7dnwdeXrIs/8g+heMBjgeXj2/nY8DzR0b9jPAP7R7fRqeD548M9XPf3K5ohVdojMrpPOx1CPz6l23XHY7PT09vVbc9rVdFs3/6w7R7U1fvtm1O4yPTeD/GHtmPPLwfUY/sRx/fL6Gm9H5YAPmIxevleD1FS9cTRBhAIEsRKNGlxWYMIhaTwTAt9RqAsMWUsLWlZgPY4YsFygklBGpVLKZEWilsyQEli01DYVnoElBCF7OjSkMIB4Kli50itmFG4YjzASTDKISdFJZHAUTIROTJiJ8JcY35hxqFtzzD+DLMhS2Kwh6PUHsuCc9vNRMtA0xZTuLWYoM2ux0IDA+sd1cdY4kldO9FNcvGrqnfgCjYclHUAAAlAnjGkwko4kClULmckq9AHAkrjpaTxjkc2ubQVqaDFs1SgGmkdoJwPwBQdft2hL6VsLYrlEAAnDC321rqxjgqBZO2uFPXAEoS9pYWxhqINGWuMDqkuYLIW/NeNS0wopQVJjlcAyPEi0NpYaY1gzs4LFR3sTX1m901wLnPRpPdiseAoB4L2M/iIq3YNtAV6OK60r1TAesbZZi7MerOVHU1CXooAeTtZla+Td3ZLx0MWItDZygRIS0pXfNRorsCNrGd81XuR4YvlD6fS8NOYllmPe9/iPfVIzLOqcnvebMWGMH5i+eRT44qC/oIWBOvj0eR7OynXgz3Yh76C6FxaD1b9qCsu0yqtaabWKZOxXmWQimlQnJNQWWx2E1K00F/x4u9NdwCQ9NO1Sdjg5tlyoMVw7X4GHQkbn6X4gJavKHb9zd023gXOtbkyHfEEuhJrk2VDekj+YBW1ZUzVaiLBVVEBDp27anoqne7A56krjYNZqGC1CCHqZg15vBa7LitCzJKXvpCF1dMZw75wmdHh8AzlTdUXR0PO/N1IonlrtYUMLMmRHkVoZ+eULL4PGJNsYUIqXyWDGH2i9kfdjB0qMUFlP1y2FVF1UFTdb3aK7HwihttSloSuwZSXlyVbaodLOUXn9c2OzOp4lEqMCQFvIHFqUrVLdfyeVpObbMHySd1AL8p8FNxEbRSfatrKPUlDE7BTCINSqG+2dq2Zuosi52u/9poHJNTxplkbzbhpPQ5x921eDrTnCya5o+D7ezT9ARGFkeKR1ufi1tT1Qr6XKp5mZZytYFWuDh1VnszPfssbtNVExtevn5j2xYKUz8aDat607R7c+FZJAWYTK19bQLLfL74YNh/qldDFHcBtlRNMLKmTO0KAPBnnVp/U7qT2o8vjgu+UIHcpMLCzbpqb7ttA0NdynyvUNSU1aaC5iev9l3mUSa9sNRNSNrgaut6t6YFdYFOUXJLVTXsQ6W679cAgAepVHBKiqRuoNGlyoHbnHSuxgXtlaV+2Kz/YwtAjkzFyms9A5kt6hk0RddMrD3l+1dIBzFepjwOks1nCb2ZWJuDqx4uTmSpSimpMt+BANpPiTt51J/rYlx1hjkQeA5K3R6lGTmY1uxtZ1tAh0450y1T7uEmrYer0W8WpG0ujHmpUbkjom27CuZ+meIrGFcydAU4eKJJndEmxpm2RocK6OOLu+mHtnmvShiZ0dWu0zXtebBJwlnsHBcNPzG+SswWNTEXBqR+6yffan4K99YbZFUhjCnKgtMCY4UpWq8NQnRdCERLAkhdHL7AluGWW0iNSkZsaRBaU1piW6w3jKqC0ZIxYQpQkC4O9nBLfyeuueGEaLaRxNiNRVQyw9drYyzBwpQMfhXyiD+dtww36EZuiDLrtZJYCUkJIoohxhFblxLRgoIupvg+LsN9uxBrveFrISWRkiFMmdGkwKVdI0ppqRXgcvEZH2wZbuelUQxLVShWUC1LgjYUISoLhdZKSgR9L3Xpee+W/i5famsM2XBbWqzKcsMFtZRYKwtkjbYF/J7jkZhx3jI0nA1T2uJSCb1RZLMmqlgruS45VUIWhBjYkf4+LkNDpyg3VgpjjN4QjjVBhdRWU2GIwWSDS2CxqXvtO7Z0/5zx1H8YtVqt+q+bAPDilt8lMA7AIJKkPkpYAkwCMJT+Y2Y917BIfYGTju2+ejK76r8wTfDFHbnWmnIPnIekSqiZChwiFda1LmDZsfiyv7U7a47QnRefh1tbl7ad9tdTZUeyUdjaQ2uPtp5eKIlUgUjuLDlae5xe66Q+EbzdjGttd2rraQt9cY+mPdVdBU1BpWi69e3H0ewnn2ws7jkdLSTlqlVeqRmP2+a0g02fVC/9VmF2/LpfT+6Zk85y0wTiP1uOwUaXcPKyQJM3yOvs/rCbfG0jUrySJMoWAMiU4u64856vGm+eDrut3cNK+tFzULeFHa0bN6c3PmyBDd/7Lg2gJG5tMPn4T6SCJ5nbIymFU91fgU6jYSqG3QPX7r5Ov/5IZfArQIdyeoVAFpenp6N5g4Fi8ed7pw4cBFKXI2ka3i/KmdSXZTcwQOWSOrFfwTC7Ezxp65RSbnnO562dNLYXJ/LPFfw080Zf7j4f/Fx18Ho1ddOboOs1zw7Vwe6q2mbPL6/fvv0PRAYUa+tCAAA="; \ No newline at end of file diff --git a/docs/documents/CHANGELOG.html b/docs/documents/CHANGELOG.html index 09c71fa..ae28a9e 100644 --- a/docs/documents/CHANGELOG.html +++ b/docs/documents/CHANGELOG.html @@ -1,6 +1,13 @@ CHANGELOG | @karmaniverous/controlled-proxy

Changelog

All notable changes to this project will be documented in this file. Dates are displayed in UTC.

Generated by auto-changelog.

-

0.1.2

-

Settings

Member Visibility

On This Page

Changelog
+

Settings

Member Visibility

On This Page

Changelog
diff --git a/docs/functions/controlled_proxy.controlledProxy.html b/docs/functions/controlled_proxy.controlledProxy.html index 09b585f..2825e5b 100644 --- a/docs/functions/controlled_proxy.controlledProxy.html +++ b/docs/functions/controlled_proxy.controlledProxy.html @@ -2,4 +2,4 @@

Remarks

See the README for usage examples.

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html index 6d9bc81..9a5b129 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,5 +1,35 @@ @karmaniverous/controlled-proxy

@karmaniverous/controlled-proxy

controlled-proxy

controlled-proxy

controlledProxy allows the behavior of any object to be modified & controlled non-destructively at runtime.

+

The developer can:

+
    +
  • +

    Alter the proxy's endpoint controls at runtime.

    +
    • +
  • +

    Specify a context-aware handler for disabled endpoints, also at runtime.

    +
    • +
  • +

    Create multiple proxies of an underlying object, each controlled differently.

    +
    • +
  • +

    Inject proxies into dependent code & control them from the outside.

    +
    • +
+

Easy use case:

+
    +
  • +

    You have a utility library with extensive logging.

    +
    • +
  • +

    You consume that library from an application that uses a custom logger like winston.

    +
    • +
  • +

    You want your utility library also to log to winston.

    +
    • +
  • +

    You normally want debug logging from the utility library disabled, even when it is enabed in the outer application, but you want to enable it selectively to help debug the outer app.

    +
    • +

Installation

npm install @karmaniverous/controlled-proxy
diff --git a/docs/interfaces/controlled_proxy.ControlledProxyOptions.html b/docs/interfaces/controlled_proxy.ControlledProxyOptions.html index b5e2b5f..6e973ec 100644 --- a/docs/interfaces/controlled_proxy.ControlledProxyOptions.html +++ b/docs/interfaces/controlled_proxy.ControlledProxyOptions.html @@ -2,10 +2,10 @@

Remarks

Type parameters will be inferred from the option values. It should not be necessary to provide them explicitly.

interface ControlledProxyOptions<Properties, Target> {
    defaultControls?: Record<Properties, boolean>;
    defaultDisabledMemberHandler?: DisabledMemberHandler<Properties, Target>;
    target: Target;
}

Type Parameters

  • Properties extends PropertyKey

    Union representing property keys of the controlled properties.

  • Target extends ControlledPartial<Properties>

    The target object type. Must have all keys in Properties.

    -

Properties

defaultControls? +

Properties

defaultControls? defaultDisabledMemberHandler? target

Properties

OptionaldefaultControls

defaultControls?: Record<Properties, boolean>

An object containing the default control flags for each controlled property. This object will be rendered as the [controlProp] property of the proxy object.

-

OptionaldefaultDisabledMemberHandler

defaultDisabledMemberHandler?: DisabledMemberHandler<Properties, Target>

The default handler function for disabled controlled properties. Defaults to () => undefined. See the DisabledMemberHandler type for more information.

-

target

target: Target

The target object to proxy.

-

Settings

Member Visibility

On This Page

Properties
+

OptionaldefaultDisabledMemberHandler

defaultDisabledMemberHandler?: DisabledMemberHandler<Properties, Target>

The default handler function for disabled controlled properties. Defaults to () => undefined. See the DisabledMemberHandler type for more information.

+

target

target: Target

The target object to proxy.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/modules/controlled_proxy.html b/docs/modules/controlled_proxy.html index 0b20c82..7544553 100644 --- a/docs/modules/controlled_proxy.html +++ b/docs/modules/controlled_proxy.html @@ -1,4 +1,4 @@ -controlled-proxy | @karmaniverous/controlled-proxy

Module controlled-proxy

Index

Interfaces

ControlledProxyOptions +controlled-proxy | @karmaniverous/controlled-proxy

Module controlled-proxy

Index

Interfaces

ControlledProxyOptions

Type Aliases

ControlledPartial DisabledMemberHandler

Variables

controlProp diff --git a/docs/types/controlled_proxy.ControlledPartial.html b/docs/types/controlled_proxy.ControlledPartial.html index 2882926..f2fda22 100644 --- a/docs/types/controlled_proxy.ControlledPartial.html +++ b/docs/types/controlled_proxy.ControlledPartial.html @@ -1,3 +1,3 @@ ControlledPartial | @karmaniverous/controlled-proxy

Type Alias ControlledPartial<Properties>

ControlledPartial<Properties>: Record<Properties, unknown>

Template type representing the controlled properties of a proxy object.

Type Parameters

  • Properties extends PropertyKey

    The property keys of the controlled properties.

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/types/controlled_proxy.DisabledMemberHandler.html b/docs/types/controlled_proxy.DisabledMemberHandler.html index 9a445c5..6d1c369 100644 --- a/docs/types/controlled_proxy.DisabledMemberHandler.html +++ b/docs/types/controlled_proxy.DisabledMemberHandler.html @@ -12,4 +12,4 @@

When not provided, this function defaults to () => undefined.

If the underlying member is a function, the handler fuction will be called with appropriate target, p, and receiver values, along with any provided args.

If the underlying member is not a function, the handler function will be called with appropriate target, p, and receiver values, and no args and its result returned.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/variables/controlled_proxy.controlProp.html b/docs/variables/controlled_proxy.controlProp.html index 45be1e2..764e2e5 100644 --- a/docs/variables/controlled_proxy.controlProp.html +++ b/docs/variables/controlled_proxy.controlProp.html @@ -1,2 +1,2 @@ controlProp | @karmaniverous/controlled-proxy

Variable controlPropConst

controlProp: typeof controlProp = ...

Symbol representing the control property of a controlled proxy object.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/variables/controlled_proxy.disabledMemberHandlerProp.html b/docs/variables/controlled_proxy.disabledMemberHandlerProp.html index 332b0f4..0854512 100644 --- a/docs/variables/controlled_proxy.disabledMemberHandlerProp.html +++ b/docs/variables/controlled_proxy.disabledMemberHandlerProp.html @@ -1,2 +1,2 @@ disabledMemberHandlerProp | @karmaniverous/controlled-proxy

Variable disabledMemberHandlerPropConst

disabledMemberHandlerProp: typeof disabledMemberHandlerProp = ...

Symbol representing the disabled member handler property of a controlled proxy object.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/package-lock.json b/package-lock.json index 6db4373..2a1c5b3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@karmaniverous/controlled-proxy", - "version": "0.1.2", + "version": "0.1.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@karmaniverous/controlled-proxy", - "version": "0.1.2", + "version": "0.1.3", "license": "BSD-3-Clause", "devDependencies": { "@dotenvx/dotenvx": "^1.19.3", diff --git a/package.json b/package.json index 21d936a..17f1a5e 100644 --- a/package.json +++ b/package.json @@ -119,5 +119,5 @@ }, "type": "module", "types": "dist/index.d.ts", - "version": "0.1.2" + "version": "0.1.3" }