diff --git a/assets/highlight.css b/assets/highlight.css index 6367f94..96f23cf 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -7,6 +7,18 @@ --dark-hl-2: #CE9178; --light-hl-3: #0000FF; --dark-hl-3: #569CD6; + --light-hl-4: #AF00DB; + --dark-hl-4: #C586C0; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; + --light-hl-6: #0070C1; + --dark-hl-6: #4FC1FF; + --light-hl-7: #008000; + --dark-hl-7: #6A9955; + --light-hl-8: #098658; + --dark-hl-8: #B5CEA8; + --light-hl-9: #EE0000; + --dark-hl-9: #D7BA7D; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -16,6 +28,12 @@ --hl-1: var(--light-hl-1); --hl-2: var(--light-hl-2); --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); --code-background: var(--light-code-background); } } @@ -24,6 +42,12 @@ --hl-1: var(--dark-hl-1); --hl-2: var(--dark-hl-2); --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); --code-background: var(--dark-code-background); } } @@ -32,6 +56,12 @@ --hl-1: var(--light-hl-1); --hl-2: var(--light-hl-2); --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); --code-background: var(--light-code-background); } @@ -40,6 +70,12 @@ --hl-1: var(--dark-hl-1); --hl-2: var(--dark-hl-2); --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); --code-background: var(--dark-code-background); } @@ -47,4 +83,10 @@ .hl-1 { color: var(--hl-1); } .hl-2 { color: var(--hl-2); } .hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } pre, code { background: var(--code-background); } diff --git a/assets/navigation.js b/assets/navigation.js index eb6167a..c726182 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52XTU/cMBCG/0vOqMC2UMptixbogXYFoj1UPbjOoFj1OtHY2YJQ/3udJpD426602pXjd57X9nrGzvfnSsGjqs6rz/pn3bFbkF0rJHzsGa8Bq4OqI6rR/ZQTKUEe+nVvGrXjWvyLibo6P16d/Tl4JX+6QCAK7uXwwTuQkrXiS6f0t5z5TCjAB0K1RSzANFqdnKaM9EB7rvJ9Rn2GzTemGr0QW2w7mTEbjzzT5A5wD1ji40ZErTaiIYKCHt1FK4aHm0eg/RA3tf1+ybAc03Go/+MbjYxaX4F6+SfWNGkXUkctxsFtEFu8JqLmrwP1ewTlUZNp48Z2uCFJwV5SYJhrELcUlQCHZhZ0aEbBy0zyE5eKbFQ0t0qz18rCjG0WiyixSk6jrDjoSd+wWu/I3wRhhqqnTvOMToty9OH98clqQXLKhU1zBJlEoxAEoIYmxXUy3oY6gmLiv1Qfs/Ir4b2zssmAYkcrXQI2vpRJs+0KFIB7q1AuPW+ZylZoKDXrPVEE75F72EZ/ijdnwnBFuuyFd+v4VSm2ez7YXFeRxwwnt92f4k1HjY2ZHmdGXxN5hW3fbRFqRvV1JoBzdPn8LeCOTadN0sQjzne6bTlkeBiyTPp0XgagU2+KtTzULglVLT7ZQI+khBrYrB5JDtU5Hn1cR1RIjiyEq0qxJW1gR2bWniAjP7nmjT1m/NtlKPW8m8ygh6lwyEOfzsSevnOw/iuUDQ1fowLIxQLFqQuhA/7xF83eiiiUDgAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52XX0/bMBTFv4ufyzK6wba+ZajAHjaqorKHiQfjXBRrrm3ZTgma9t2nkEAT/8+kviQ+93cc1+c6+fUHGWgNWqEf0JpS0i1oKbiGrw1lFSi0QBKbGq0QYVhr0IVf9642e4YW6DflFVqdLj//XbyRdxxaCcRANapbKyU89LDWcVj0RWiFjK5OqD6B1oDimKGR97cLBdjATnc/dQtaU8FvpKGC66M75QbUIyagi1jBdArLs/OU0RZ0w0y+T6/PsPlJTV1KulFC6oyn8cgzTW5BHUDN8XErolZrXmNOoJT0QvDu5roF0nR1w7XfL1mWY9pP9X98o5VR6yswr/9ESZJ2IXXUop/cS2iuMa/Y20T9HkF51GTYuLEdPpGkYK8R6J41iBuL5gC7yyxodxkFj5PkJ44V2ahotuam10phxjaLVcyxSj7GvOZQSvqdVhWDJ6zgCDXPEnQxGbQo7798Oj1bjkhOu7BpjiCTOGkEAehEk+I6ibehjmA28SXqfSrvMGuclU0WzHa04hKw8UUmzbY7UADu7UK59LxlmrdCXaspD9hgtVPMw56Mp3jHJHSvZ5cN924dvyrFds8Hm+sq8pjhcNvjKd5w1NiY4XZm9TXWV0o0cqOgogQbZ1YhXT5/A2pPh9MmaeIR5zttBYMMj4kskz6clwHoMJpijQ+1S0yMUM820COZQw1sVo8kh+ocjz6uI5pJjiyEq0qxNalhj4+sA1YUPzDQRT8yrf8wLiWeb5Mj6HFoHLrw6abY848O1v8KZUPDr1EB5GiB4tSRMAI2tRJPN9z7Perjx/S2TeTL9f4fXrExXpEPAAA=" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index aff0ccc..05f1410 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81dW4/TyBL+L8nrnCFtu902bxwYYKU9gLjseRghZBIPY20myXGS2UWI/37c7VtVu6p9y0pIaDOJ6/5VVXdXHO+PRb7/67h4evtj8We22yye+t7VYpc8pIuni+P6Pn1IFleLc74t3j4meZZ83abHJ+WF6/vTw7a4ut4mx2NayFgsfl7VYrxVrIRsZT07ZP/JNptt+leSp43I0/dDIQ5dc0oNpfTDRuaXL5q/V9iyoQMyrxaH4vru1DENuCBbVb99SPPHNL/J833+OtkVxPnz/e6U/n1q1GfF2/wuWRc28NRO78TKCxqNqWaeIHxZM9LOOhzhDPk7XZ9P6Yv0Ljlvp7i77Ei4lGl5+r9zepxkU8t6OWOOh/3umE6zpuGdYY5dc21WvykIX55361O231n1QhPNrUKH1L5yZKzm3eyGxjKmSzDXPUZin2uEpX1usU3TvnwZl0a2zo6NoDa8qFGogSy67Psqy/99zrYbgFIl+wlN5nRMijZg64LplJ/Xp/0o0UvMRzvKeAAi3DaCdZ4mp/S/2em+4HiX7w/Hxpy7KpuPT7pEo5bTm919slunBa+9DJVodq7PTQ9aYF9+dM3kXXqVnupQPKMaVef6XJdogX0udc0c4RLOBsaM8dnQEVHkKVyrGUUl1SU0/ZFsz73hBaTzdJoGOkKxTe/WDnd9zztV+vZg6pdc5FnqEbu+smBce0u3lmVHArOh4F1jTKviOMWmlnWGMQiYTmO5MXvMgsUVul6u4UCtZ6tZrvsg6neSg8qRpAONa0Vc2rjj/f683Xw47Q9z7ENSLmAiyq5OB3ElFUc8PJdcxxin9P5TDOvJlENMny19Z5ixxhzT3aYgudtm6ynBsdinG+XcS0yz57pnl8GLQl45Avdyn38t9uXpbqKlkP+XCF1jUBW7fwUTo9d65gjfi+SUTDS0Yv0lgqZtqePlTYyX8ccRqt+zSb0LsP4SodK21KEKJ4bK+OMI1Zu9od5NjRfk/yWC1hhURy6aGLnWM2f4Ti/35+LSVGMb9l8keKU9dezEanLwKsccsStOPtkmaY5DE03uSvklImmZ1QR0asuz3WT2ieSMB1o+eL6D4DoMl7esaRkvkYUDvHAdb2cdbJ+/ffPm5vnHUYKXLdMA93qOry9ufr/5eDNOf8MzX/2rm5G+lwzzFX9LT8PyE2kHXPNNeH3z7MU49RXHfNVv33387e2bD+O0t0zzDXj37OPz1+PU1ywXUP72w8isqzguoPrTWM2fLqP44/tnz0eWec0yX/mZOTmzqs+u83LPPMwak0Jq+nswgmLuDJ0T2TdFp4wd5trLRH9R891hR0VxSdegyDGu1cb2fE9Ufo3W/1URoJvybVHJ7vzCCJFc6DujrsyBXxthe3tH9CA6w6b0XYZ/aFDPKJowqyd8nDWu5ywbMbF3mkQN7RGsY+b2TsaLju77NQ2e3ru9nT7AH2Di0Bn+JBNz/BXjNAsbIf+AgcO+Zxhg5IivGoYa2jl/gSLq/8bBxTC8DHYF9SwtSyzBsYlhvRsWkb5D6Zw+7tqxcc2xd9PmbonE5qYTIGIv0qG5xAaHFjpki9M1ebCL/BauS3RhJ8du5AirHXu5T0f9L/+QHo8QQ3srh8nG3guhWZ89Jqck/5RvLW/tyxe4RaYrb8AdMthG584NB6N/40bSD6/3ZPOQ7V7l+zO9KvTpWCJ+596Idsxl1rs0f8hw6oy3DQm5sIHv91u6Ww4zrWK/nFFft/v1n+lmBpyWhIubNhdSSszFjZwOKxZwOcNcW/Reo3p35hMM+sb13VGWEVJmmdjbTt/zm3SefNTmSXNPkb9seUeEoPLHbY69/E6wqhUxxzgET0XrQARRDAdhkx0P2+T7G/1umNglZmFcxAZzdaEbJ71cE3ob6jkq75Mj3/AJpYB+ptqeZk7rHtK6hxrANmpatbstD1J6aKwfDDJmmaX8fn/ac82W0tzSz1GbF2Eb7G1NPEfh0dGwCJXHvubEKbX7Ud249PGGUw5pRi0M9KpASVyeneuAbegwf9h1iaC7aK8lhQ/uuB0XJvVd2oYB3Xeo+oy+BYdVnTnuuRmhdkA3ovUP7UlDDXG2CNqE/kbhUG6PAT5ZG6/ytF59OvfQD8X0nfVrQ3pNfV2twu/ydJOti70TrbRDdiFnaLkDvevaPsTdduHv95mgvZzjnPDh3lOuDAmB3oD0O4+oLud2V+xwh7Hhva7aJw5kypAx33DHoLSB/tTW/fx8VbSqTfr34umPxWOamw+fLrxr/zou2O6ydLspRNyWZhRC9w8PWtDn6tofqR6AaoqS5MlqcXW7ugqC69ATnz9f3dYc5oL5wJCJ4p2gyAQi84p33pUIr8MoRmQeIvOLdz4lzUdkQfEuoMgCRCaLd5Iik4gsLN6FV358LYWHyEJEpop3iiJTiCwq3kWU0giRxVxAYhxeHe2YjK+Fg+AECoyEvm3yVpDICgyG8FmRGA6hwy7oLMCICB154ZGUGBShgy/IXBAYF6HjL8h0EBgaEbEOYXCEBkGQqSMwPt6KTWyMj2cKJaREelapGIAUSYkB8jQMgkw2DyPkGYTIPPIwQp6GwSPTw8MIeRoGT1AV4WGEPA2D55GUGCHPIESi7mGIPFNAwZUfXosgwpQYIt9AJClKH2PkmxoiW4GPMfJNPyMx8q2O5nPdxccQ+QHXX3yMkG8QIlH3MUJ+yCWnjwHyDUBkevgYIJ8tIR/j42sQfDKPfIxPwJZQgOEJNAY+2WYCDE/ALjcBRicwCw7ZjwJryQlYkRieQGPgkykcYHgCFp4AwxNoDHx6wcPwBCw8AYYnMPCQHS7A8EgNgk82LonxkQYfsigkxkdqFHwyhSUGSBqAyMyUGCBpNgVkwklrW6BhCMg8khghqXEIyPSQGCKp2CYjMURSAxGQ+SExRlIDEZCwS4xRqIEISDRDjFGogQhINEOMUaiBCMiGFGKMQg1EQKIZYoxCtohCDFFoICJhD63NG1tEIUYo1DBIMj9CjFCoYZBkfoQYoZDdxYUYIKVRkGQiKQyQEuyqqjBAymNXVYUBUhoFSaacwgCpgF1VFUZISTbhFUZIaRwkmcbK2mErdv1VGCJlICITXmGIlAZCkgmvMEaRwYhsXxHGKBJsaUQYo0gDIenjAMYoYjfbEYYo0jhIsjQiDFEkWZEYocicgMjSiDBCkYYhJLMzso5B7EoUYYAijUJIlkaEAYo1CiGZxjEGKNYohGTKxRigWKMQkokUY4Bis5EjEynGCMUahpBMpBgjFGscQjI9YgxRHLKFGWOIYh6iGEMUayBCMpNi67CqgVArUqZ9XtVIKFJ9eQ3SaiwUfRpcWafWlUZD+bRc69y60niogKa1jq4rs+2mj3or6/C60pgoMgXKa5BWo6LIJCivQVozWohoe60j7Eojo5iJgHWKXWlsIhK28hqgNeOEiD7Dd0YNGpuIxs2eNpiZQkSf4+15gxkrRPRJ3h45mMECkw/20MGMFph8sMcOZrgQ0flgDx6EAzd79GAmDAwW9vRB8OUmrPmD4AcQwppACDNniOj09ewhEXuCEtYQQphRQ0RnujWGEB67ARTWHEKYaUNE9kZhTSKEx24ChTWKEGbgwPQnaxghPH5eVE0jzND1Mc1P6ea3cvh6e9tMeH8svlQT2Wam/GPhFf/5ebWIy5eiWspXv3qNytcCOvNanNPL1+rzoPo8qMQUZ8/ytaILKrqw+jysPg8rfVGlp9gAlK8VvagVanSrP4L6j7D+wxD/bGfH+p2Oirn/71t5G0brdLFSN17HKxfrAdxFAfgDwC9c/Lm5FQJwSsDpcZyH7AE8frHlFi0zp7W6M67rcggU+25mxmkFJARuCR23I8ArGd71frdL9SNzWj4f8EkuXOg5iiBYILWFQ2d5zx6oCACuVyWnqjIuDjk55r6s81H/y5sbJUAAVq3QyC3kr+x0X2RA9QN74A9IWtEv4mjuIO9IkcCQ4nBJS9mk2/SEAPRjAASXPtXNBoYO8Cpo+KouYsGlUPXjtCIEBDgCgCM48ysJFLaggurmobhSqsSUgSSESSAs5BpQ9VTklgs4wEagfG7xpn5uMVAJUGCYv6WIIwB4S05hwVNnXFL9DASEHCgV8VAJxu/yZ1aP5bMSgUSQTN5gm7oFAVqax4HYEVP/9AvIAY3N45oMI6frG+hYHlcohbCONwHIJukAVzeYxNzIq7+lhS0GCIhU1a+4EqnvyQFVCitrVS/6bOO8T46dNUbBTFlxwBac9AKjQsjuUGyvLkpBRq413qfJBgUcrA+SY8qoxt78vhEEHwiLuCIhhXXzMQTlEXN9JesuFoRZHqh+j4toRi4ahDQJnFTctilDQY5gSrCrVtbp+Wn9G0aqiYP1hN34ZVT3dkmVQKriCjfrtAHKPpCOPtdPstIw0ybvywcREKKATaxJIJcO5oZKEH24BRJci7QllLdFAimwMwiXHZqzm88KWrFireD2PT5IoYAtrZ5C8AEm0mkCKAEWYQlMUmwGDigoYFXEFVR7FNC/e71rnqYPAAJSGCGatQhP/azMr/WT0MHCBQ8XXO/WYqh4gM6tOIiqPQGqFHj6rJYsxVUM1d4ADn51TJS1HK7dHZLT+h4tBKDKJBdAdCcnyO0I5raqV01u2TV3ilvrtoqhCFb//oj3daAoJRfybi0BoCSXcIcz1gSCHHI8zQNhwTIG2Mq4+FzvaB/hCsICUqpi57Ky23IkiI7iVp3qzlhQRyuIRDMH4SCp/zc1rQDAzwVKP+Vt3TwcFqQySCSfS13NvDFP+QSQAqU+lwia8a59sCpQC5LP57JWc28zjK4P2kXANVTNuNuv60dHAm5Q+AGXFSX36a58dCJgBvUauEL12DxNr9N5fHgM4/22l2goApWtUwIzzIHZxjU9YpQQwUbNazYPjzie8IbAA0XpVwM+xbl/ypM1sjiAJc1hfsZlHIA6Dquzf+TgxTsPODlgY1RtPFDzALGNm0LmqqMSUB9pDu2dw8AUeDhhT5utpHa9oMXBIwt7TmzF6V5FC4ILELvF5wdTCmbTqhm1cjkBt1l39eMUANqgKELOGCiDqKsAeBRykSF3amgFgJsiLnMsKYRDEjgUkevP56tF4Uu6zXYF0e3nnz//D+1O5h3abAAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81dW4+byBL+L8yrz8QNdAPzNmcy2ay0J4ly2fNgRStiMxm0HtsH8GxWUf77UTe3Kqhqbl4pUiQnpu5fVXV3gcl3Jzv+lTs3m+/On+lh59x47so5xE+Jc+Pk28fkKXZWzjnbOzfOc5yl8Zd9kr8oL1w/Fk97Z+Vs93GeJ7lz4zg/VrUYdx0FQraybk/pf9Ldbp/8FWdJI7L4+5TkL9A1q1QlpacamX/8ofkHhV01dEDmyjnFWXIoeqYBF2Sr6tcPSfacZPdZdsxex4fdPsnujoci+VY06tNDkWQP8TbJX/DUVu/E2vUbjYlmniH8qmaknbU4whnyLdmei+Rl8hCf93PcvepJuJRpWfK/c5LPsqllvZwx+el4yJN51jS8C8zp1lyb1W+Sb8Wr82FbpMdDp15ooqVVaJE6VI6M1byb/dB0jOkTLHWPkTjkGmHpkFts0+xevoxLE1tnz0ZQG27YKNRA3p7S91WW//uc7ncApUr2C5rM6pgUbcC2x0NeZOdtcZwk+grz0Y4yHoAIt41gmyVxkfw3LR5vT+m77HjKG3MeqmzOX/SJJi2n94fH+LBNbk9pdxkq0exdX5oetMCh/Oibybv0S1LUobilGlXv+lKXaIFDLvXNnOASzgbGjOnZ0BPxPsnhWs0oKqkuoen3eH8eDC8gXabTNNAJirv0du1w13fXq9K3J1O/5CLPUk/Y9ZUFY9tb2rVc9SQwGwreNca0Ko5zbGpZFxiDgOk1lnuzx0yPB1voBrnGA7VdrOZqOwTRsJMcVJYkHWlcK+LSxuWPx/N+96E4npbYh6RcwESUXb0OYksqjnh8LtmOMVbpw6cY1pM5h5ghW4bOMFONyZPD7u54eNin2znB6bDPN8q6l5hnz/XALoMXhbyyBO7VMfuS7nbJYaalkP+nCF1jUBW7f/kzo9d6Zgnfy7iIZxpasf4UQdO21PFyZ8bL+GMJ1W/prN4FWH+KUGlb6lCpmaEy/lhC9eZoqA9z4wX5f4qgNQbVkQtnRq71zBq+4tXxfNjNNrZh/0mCV9pTx06sZwevcswSu9/jfbqLm+PQTJP7Un6KSHbMagI6t+V13WT2ieSMB1o+er6D4DqNl3dV0zJeIgtHeGE73i462N69ffPm/u7jJMFXLdMI9waOry/vf7v/eD9Nf8OzXP0v9xN9LxmWK/6aFOPyE2kHXMtNeH1/+3Ka+opjueq37z7++vbNh2naW6blBry7/Xj3epr6muUCyt9+mJh1FccFVH+aqvnTZRR/fH97N7HMa5blys/MyZlVfbadlwfmYZ0xKaSm74MRFEtn6JzIoSk6Zew4117F+kbN3xY7KopLugZFTnGtNnbgPlF5G234VhGgm3O3qGS33jBCJBe6Z9SXOfK2EbZ3cEQPojNuSt9n+IcG9YyiGbN6wsdF43rOsgkTe6tJ1NAewTplbm9lvOjofljT6Om93dv5A/wRJo6d4c8yMcO3GOdZ2Aj5Bwwcd59hhJETbjWMNbR3/gJFNHzHwcYwvgwOybdikZYrLMGyiWG9GxeRoUPpkj5u27FxzXFw02ZvicTmphcgYi/So7nEBocWOmaL0zd5tIv8Fq5PdGEnp27kCKste7lPuf6TfUjyHGLY3cphsqnPQmjW2+e4iLNP2b7/6AO6fIFHZPryRjwhg2207txwMIY3biT9+HqPd0/p4ZfseKZXhSEdV4jfujeiHbOZ9S7JnlKcOtNtQ0IubOD7457uluNMq9gvZ9SX/XH7Z7JbAGdHwsVNWwopJebiRs6HFQu4nGG2LfqgUYM78xkGfeX67iTLCCmLTBxsp+/5TTpPPmnzpLnnyL9qeSeEoPLHbk53+Z1hVStiiXEInorWggiiGA/CLs1P+/jvN/pf48ReYRbGRWwwVxe6cdLLNaG3oV6i8jHO+YZPKAX0C9UONHNa95jWPdYAtlHTqu1teZTSU2P9aJAxyyLlj8fiyDVbSnNLv0Rtdtwno72tiZcozC0Ni1CZDzUnTmm3H9WNSx9vOOWQZtLCQK8KlMSrs3Ud6Bo6zh92XSLoLtprSeGjO27PhVl9l7ZhRPcdqz6lH8FhVaeWZ24mqB3RjWj9Y3vSWEOsLYI2YbhRWJR3xwCfOhuv8rRefbv00A/FDJ31a0MGTX1drcLvsmSXbuOCUdoju5AztNyR3vVtH+Nuu/AP+0zQXs5xTvh47ylXxoRAb0CGnUdUl3O7L3a8w9jwQVe7Jw5kypgx33jHoLSR/tTW/fi8ctLDLvnm3Hx3npPMfHnjuNfedeSsnIc02e/0mwBKM1bO9vj0pAV9rq79nugBqKYoSV6sndVmvfL9a+WKz59Xm5rDXDBfGDLhrDaCIhOIzHVWG3cl1LUKI0TmIjLPWW08SpqHyHxntfEpMh+RSWe1kRSZRGTKWW3UyouupXARmUJkgbPaBBRZgMhCZ7UJKaUhIou4gEQ4vDraERnfDg6CEygwEvqxyY0gkRUYDOGxIjEcQodd0FmAERE68sIlKTEoQgdfkLkgMC5Cx1+Q6SAwNCJkHcLgCA2CIFNHYHzcNZvYGB/XFIqiRLqdUjEABSQlBsjVMAgy2VyMkGsQIvPIxQi5GgaXTA8XI+RqGFxBVYSLEXI1DK5LUmKEXIMQibqLIXJNAfkrT10LP8SUGCLPQCQpSg9j5JkaIluBhzHyTD8jMfI6Hc3juouHIfJ8rr94GCHPIESi7mGEPMUlp4cB8gxAZHp4GCCPLSEP4+NpEDwyjzyMj8+WkI/h8TUGHtlmfAyPzy43PkbHNwsO2Y/8zpLjsyIxPL7GwCNT2Mfw+Cw8PobH1xh49IKH4fFZeHwMj2/gITucj+GRGgSPbFwS4yMNPmRRSIyP1Ch4ZApLDJA0AJGZKTFA0mwKyISTnW2BhsEn80hihKTGwSfTQ2KIZMA2GYkhkhoIn8wPiTGSGgifhF1ijJQGwifRVBgjpYHwSTQVxkhpIHyyISmMkdJA+CSaCmOk2CJSGCJlICJhV53NG1tECiOkNAySzA+FEVIaBknmh8IIKXYXpzBAgUZBkokUYIACwa6qAQYocNlVNcAABRoFSaZcgAEKfHZVDTBCgWQTPsAIBRoHSaZx0NlhB+z6G2CIAgMRmfABhijQQEgy4QOMUWgwIttXiDEKBVsaIcYo1EBI+jiAMQrZzXaIIQo1DpIsjRBDFEpWJEYoNCcgsjRCjFCoYVBkdoadYxC7EoUYoFCjoMjSCDFAkUZBkWkcYYAijYIiUy7CAEUaBUUmUoQBisxGjkykCCMUaRgUmUgRRijSOCgyPSIMUaTYwowwRBEPUYQhijQQisykqHNY1UAEa1Jm97yqkQhI9eU1SKuxCOjT4Lpzal1rNAKPlts5t641HoFP03aOrmuz7aaPeuvO4XWtMQnIFCivQVqNSkAmQXkN0prRQkjb2znCrjUyATMR6Jxi1xqbkIStvAZozTghpM/wvVGDxiakcetOG8xMIaTP8d15gxkrhPRJvjtyMIMFJh+6QwczWmDyoTt2MMOFkM6H7uBBWHDrjh7MhIHBojt9EHy5ic78QfADCNGZQAgzZwjp9HW7QyL2BCU6QwhhRg0hnemdMYRw2Q2g6MwhhJk2hGRvFJ1JhHDZTaDojCKEGTgw/akzjBAuPy+qphFm6PqcZEWy+7Ucvm42zYT3u/NHNZFtZsrfHde5+f5j5UTlhxDVp1d9huWnuy4/PVV9Vt/71fd+Jcb3q8+Kzq/oVPW9qr5Xlb6w0hPK6rOiF7VCjW71F7/+i6r/Yoh/tLNj/S8dFfP839fyMYzWaeW1XkdrG+sJPEUB+H3AL2z8mXkUAnBKwOlynKf0Cbx+seUWLTOntXoyru+yAoo9OzPjdAAk+HYJPbdDwCsZ3u3xcEj0K3NaPg/wSS5c6D2KIFggtYVFZ/nMHqgIAK5bJWdQZVykODnmuaxzrv9kzYMSIADrVmhoF/JXWjzGp7T6gT3wByStGBaRmyfIe1IkMEQFjJRdsk8KBKAXASC49KkeNjB0gDeAhq/rIhZcClU/TotPKQGOAOAIzvxKAoUtqKC6eQRcKVViykASwiQQprgGVL0VueUCDrARKN9bvKvfWwxUAhQY5q8J4vAB3pJT+DUp6oyLq5+BgJADpSIaK8H4Xf7M6rl8VyKQCJLJHW1TvyBAS3M5EHti6p9+ATmgsblck2Hk9H0DHcvlCuVrUvS88UE2SQu4usHE5kFefZcWthggIAyqfsWVSP1MDqhSWFnretFnG+djnPfWmABmypoD9jHO6QUmUJDdori7ugQBZORa42MS71DAwfogOaaUauzN7xtB8IGwkCsSUlg/HxUoj4jrK2l/sSDMckH1u1xEU3LRIKRJ4GTAbZtSFOQQpgS7aqW9np/Uv2GkmjhYT9iNX0p1b5tUCaQGXOGmvTZA2QfS0eP6SVoaZtrkY/kiAkIUsIk1CeTSyTxQCaIPt0CCa5FdCeVjkUAK7AzCZofm7OdzAK1Ys1Zw+x4PpJDPltZAIXgAE2k1AZQAi7AEJgVsBo4oKGBVyBVUexTQv3t9aN6mDwACUhghmjU+pfW7Mr/Ub0IHCxc8XHC9W4uh4gE6d8BBVO0JUKXA02e1ZAVcxVDtDeDgVcdEWcvh2t0pLraPaCEAVSa5AKInOUFuhzC3g3rV5JZd86R4Z90OIiiC1X/M8b4OFKXkQt6vJQCU5BLudMaaQJAVx9O8EBYsY4CtjIvH9Y72Fa4gLCClKnYuK/stR4LoBNyqUz0ZC+poDZFo5iAcJPV/U9MKAPxcoPRb3rbNy2FBKoNE8rjU1cw785ZPAClQ6nGJoBkf2herArUg+TwuazX3PsXoeqBd+FxD1YyH47Z+dSTgBoXvc1lRchcP5asTATOoV98WqufmbXq9zuPBYxjvd3eJhiJQ2VolMMMcmG1c0yNGCSFs1Lxm8/KIvMAbAhcUpVcN+ALO/SKLt8hiH5Y0h/kZl7EP6lhVZ//Qwot3HnBywMao2nig5gFiGzWFzFVHJaA+0pzaJ4eBKfBwwp42W0ntekGLg0cW9pzYitO9ihYEFyB2i88PpgKYTetm1MrlBNxmPdSvUwBog6JQnDFQBlFXPvBIcZEhd2poBYCbIi5zOlIIhyRwKCTXn88r55Sekn16SJybzecfP/4P7U7mHdpsAAA="; \ No newline at end of file diff --git a/classes/NextApiResponseBuilder.html b/classes/NextApiResponseBuilder.html index bfbaf12..9ec7724 100644 --- a/classes/NextApiResponseBuilder.html +++ b/classes/NextApiResponseBuilder.html @@ -1,5 +1,5 @@ NextApiResponseBuilder | @egomobile/next-utils

Class NextApiResponseBuilder

Next.js version of ApiResponseBuilder class.

-

Hierarchy

  • ApiResponseBuilder
    • NextApiResponseBuilder

Constructors

constructor +

Hierarchy

  • ApiResponseBuilder
    • NextApiResponseBuilder

Constructors

constructor

Properties

request response

Accessors

data @@ -16,7 +16,7 @@ withList withStatus withSuccess -

Constructors

constructor

Properties

Readonly request

request: IHttpRequest<any>

The underlying request context.

+

Constructors

constructor

Properties

Readonly request

request: IHttpRequest<any>

The underlying request context.

Readonly response

response: IHttpResponse

The underlying response context.

Accessors

data

  • get data(): Nullable<ApiResponseData>

  • Gets the data to return.

    Returns Nullable<ApiResponseData>

    The data to return.

    @@ -51,4 +51,4 @@

withSuccess

  • withSuccess(value?): NextApiResponseBuilder

  • Sets the value of the 'success' property.

    Parameters

    • Optional value: boolean

      The new value.

    Returns NextApiResponseBuilder

    That instance.

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/UnexpectedApiResponseError.html b/classes/UnexpectedApiResponseError.html new file mode 100644 index 0000000..1dcb986 --- /dev/null +++ b/classes/UnexpectedApiResponseError.html @@ -0,0 +1,16 @@ +UnexpectedApiResponseError | @egomobile/next-utils

Class UnexpectedApiResponseError

Is thrown on an unexpected API response.

+

Hierarchy

  • Error
    • UnexpectedApiResponseError

Constructors

constructor +

Properties

message +name +response +stack? +prepareStackTrace? +stackTraceLimit +

Methods

captureStackTrace +

Constructors

constructor

  • new UnexpectedApiResponseError(response, message?): UnexpectedApiResponseError

  • Initializes a new instance of that class.

    +

    Parameters

    • response: AxiosResponse

      The response context.

      +
    • Optional message: string

      The optional message.

      +

    Returns UnexpectedApiResponseError

Properties

message

message: string

name

name: string

Readonly response

response: AxiosResponse

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/createUseUserSession.html b/functions/createUseUserSession.html index 2773c3e..da0d7d2 100644 --- a/functions/createUseUserSession.html +++ b/functions/createUseUserSession.html @@ -1,4 +1,4 @@ createUseUserSession | @egomobile/next-utils

Function createUseUserSession

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/createWithApiProps.html b/functions/createWithApiProps.html index 3631cd5..ef7d1fd 100644 --- a/functions/createWithApiProps.html +++ b/functions/createWithApiProps.html @@ -2,4 +2,4 @@ that is used for API endpoints in Next.js.

Type Parameters

Parameters

Returns WithApiPropsFactory<TContext>

The new factory function.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/createWithServerProps.html b/functions/createWithServerProps.html index 805640f..aac9641 100644 --- a/functions/createWithServerProps.html +++ b/functions/createWithServerProps.html @@ -2,4 +2,4 @@ that is used for SSR rendered pages in Next.js.

Type Parameters

Parameters

Returns WithServerPropsFactory<TContext>

The new factory function.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/throwOnUnexpectedApiResponse.html b/functions/throwOnUnexpectedApiResponse.html new file mode 100644 index 0000000..f306b38 --- /dev/null +++ b/functions/throwOnUnexpectedApiResponse.html @@ -0,0 +1,7 @@ +throwOnUnexpectedApiResponse | @egomobile/next-utils

Function throwOnUnexpectedApiResponse

  • throwOnUnexpectedApiResponse(response, expectedStatusCodes, errorMessages?): Promise<void>

  • Throws an exception on an unexpected API response.

    +

    Parameters

    • response: AxiosResponse

      The response context.

      +
    • expectedStatusCodes: number[]

      One or more expected HTTP status codes.

      +
    • Optional errorMessages: Nilable<ApiResponseErrorMessages>

      An optional repository of error messages by status code.

      +

    Returns Promise<void>

    Example

    import axios from "axios"
    import { throwOnUnexpectedApiResponse } from "@egomobile/api-utils"

    const response = await axios.get("https://api.example.com")

    // we expect `200` as response
    await throwOnUnexpectedApiResponse(response, 200)

    // same as an array, which makes it possible to expect more than
    // one possible status code
    await throwOnUnexpectedApiResponse(response, [200])

    // as validator function
    await throwOnUnexpectedApiResponse(response, (context) => context.response.status === 200)

    // this will throw special errors messages, for status codes beginning with 4 or 5
    //
    // the first match always "wins"
    //
    // following template placeholders are supported:
    // - {{body}} => response body as text with a maximum length of 131072 chars
    // - {{headers}} => list of HTTP response headers as one single text
    // - {{messages}} => list of extracted API messages items as one single text
    // - {{statusCode}} => HTTP status code, like 200, 404, 500 etc.
    // - {{statusText}} => text representation of HTTP status code, like `OK`, `Not Found`, `Internal Server Error` etc.
    //
    await throwOnUnexpectedApiResponse(response, 200, {
      "^4": "Unexpected client error: {{statusCode}} {{statusText}}\n\n{{body}}",
      "^5": "Unexpected server error: {{statusCode}} {{statusText}}\n\n{{body}}"
    })
+
    +
  • throwOnUnexpectedApiResponse(response, expectedStatusCode, errorMessages?): Promise<void>

  • Parameters

    • response: AxiosResponse
    • expectedStatusCode: number
    • Optional errorMessages: Nilable<ApiResponseErrorMessages>

    Returns Promise<void>

  • throwOnUnexpectedApiResponse(response, validator, errorMessages?): Promise<void>

  • Parameters

    • response: AxiosResponse
    • validator: ApiResponseValidator
    • Optional errorMessages: Nilable<ApiResponseErrorMessages>

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html index 8bab158..0a515d1 100644 --- a/index.html +++ b/index.html @@ -11,4 +11,4 @@

TBD

Documentation

The API documentation can be found here.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/ICreateUseUserSessionOptions.html b/interfaces/ICreateUseUserSessionOptions.html index 9f553a9..69fe933 100644 --- a/interfaces/ICreateUseUserSessionOptions.html +++ b/interfaces/ICreateUseUserSessionOptions.html @@ -1,5 +1,5 @@ ICreateUseUserSessionOptions | @egomobile/next-utils

Interface ICreateUseUserSessionOptions<TSessionProp>

Options for createUseUserSession() function.

-
interface ICreateUseUserSessionOptions {
    adminGroup?: Nilable<string>;
    adminPermission?: Nilable<string>;
    adminRole?: Nilable<string>;
    blockedGroup?: Nilable<string>;
    blockedPermission?: Nilable<string>;
    blockedRole?: Nilable<string>;
    context: Context<Nullable<TSessionProp>>;
    getUserAvatarUrl?: Nilable<GetUserAvatarUrl<IUserSessionProp>>;
}

Type Parameters

Properties

adminGroup? +
interface ICreateUseUserSessionOptions {
    adminGroup?: Nilable<string>;
    adminPermission?: Nilable<string>;
    adminRole?: Nilable<string>;
    blockedGroup?: Nilable<string>;
    blockedPermission?: Nilable<string>;
    blockedRole?: Nilable<string>;
    context: Context<Nullable<TSessionProp>>;
    getUserAvatarUrl?: Nilable<GetUserAvatarUrl<IUserSessionProp>>;
}

Type Parameters

Properties

adminGroup? adminPermission? adminRole? blockedGroup? @@ -10,21 +10,21 @@

Properties

Optional adminGroup

adminGroup?: Nilable<string>

Custom name of "super-admin" group.

Default

"admin"
-

Optional adminPermission

adminPermission?: Nilable<string>

Custom name of "super-admin" permission.

+

Optional adminPermission

adminPermission?: Nilable<string>

Custom name of "super-admin" permission.

Default

"admin"
-

Optional adminRole

adminRole?: Nilable<string>

Custom name of "super-admin" role.

+

Optional adminRole

adminRole?: Nilable<string>

Custom name of "super-admin" role.

Default

"admin"
-

Optional blockedGroup

blockedGroup?: Nilable<string>

Custom name of "totally blocked" group.

+

Optional blockedGroup

blockedGroup?: Nilable<string>

Custom name of "totally blocked" group.

Default

"blocked"
-

Optional blockedPermission

blockedPermission?: Nilable<string>

Custom name of "totally blocked" permission.

+

Optional blockedPermission

blockedPermission?: Nilable<string>

Custom name of "totally blocked" permission.

Default

"blocked"
-

Optional blockedRole

blockedRole?: Nilable<string>

Custom name of "totally blocked" role.

+

Optional blockedRole

blockedRole?: Nilable<string>

Custom name of "totally blocked" role.

Default

"blocked"
-

context

context: Context<Nullable<TSessionProp>>

The context, which stores the session prop.

-

Optional getUserAvatarUrl

getUserAvatarUrl?: Nilable<GetUserAvatarUrl<IUserSessionProp>>

Returns a user avatar by session.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

context

context: Context<Nullable<TSessionProp>>

The context, which stores the session prop.

+

Optional getUserAvatarUrl

getUserAvatarUrl?: Nilable<GetUserAvatarUrl<IUserSessionProp>>

Returns a user avatar by session.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/ICreateUseUserSessionResult.html b/interfaces/ICreateUseUserSessionResult.html index 96459c3..0a34ce5 100644 --- a/interfaces/ICreateUseUserSessionResult.html +++ b/interfaces/ICreateUseUserSessionResult.html @@ -1,6 +1,6 @@ ICreateUseUserSessionResult | @egomobile/next-utils

Interface ICreateUseUserSessionResult<TSessionProp>

Result of createUseUserSession() function.

-
interface ICreateUseUserSessionResult {
    useUser: UseUser<TSessionProp>;
    useUserSession: UseUserSession<TSessionProp>;
}

Type Parameters

Properties

useUser +
interface ICreateUseUserSessionResult {
    useUser: UseUser<TSessionProp>;
    useUserSession: UseUserSession<TSessionProp>;
}

Type Parameters

Properties

useUser useUserSession

Properties

useUser

useUser: UseUser<TSessionProp>

The new useUser() hook.

-

useUserSession

useUserSession: UseUserSession<TSessionProp>

The new useUserSession() hook.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

useUserSession

useUserSession: UseUserSession<TSessionProp>

The new useUserSession() hook.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/ICreateWithApiPropsOptions.html b/interfaces/ICreateWithApiPropsOptions.html index ac63e55..d7ef308 100644 --- a/interfaces/ICreateWithApiPropsOptions.html +++ b/interfaces/ICreateWithApiPropsOptions.html @@ -1,6 +1,6 @@ ICreateWithApiPropsOptions | @egomobile/next-utils

Interface ICreateWithApiPropsOptions<TContext>

Options for createWithApiProps() function.

-
interface ICreateWithApiPropsOptions {
    enhanceContext?: Nilable<EnhanceApiContext<TContext, any>>;
    onError?: Nilable<ServerErrorHandler>;
}

Type Parameters

Properties

enhanceContext? +
interface ICreateWithApiPropsOptions {
    enhanceContext?: Nilable<EnhanceApiContext<TContext, any>>;
    onError?: Nilable<ServerErrorHandler>;
}

Type Parameters

Properties

enhanceContext? onError?

Properties

Optional enhanceContext

enhanceContext?: Nilable<EnhanceApiContext<TContext, any>>

The optional and custom function, that enhances the TContext based object.

-

Optional onError

onError?: Nilable<ServerErrorHandler>

Custom and additional error handler.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional onError

onError?: Nilable<ServerErrorHandler>

Custom and additional error handler.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/ICreateWithServerPropsOptions.html b/interfaces/ICreateWithServerPropsOptions.html index 411fa43..d9230dc 100644 --- a/interfaces/ICreateWithServerPropsOptions.html +++ b/interfaces/ICreateWithServerPropsOptions.html @@ -1,6 +1,6 @@ ICreateWithServerPropsOptions | @egomobile/next-utils

Interface ICreateWithServerPropsOptions<TContext>

Options for createWithServerProps() function.

-
interface ICreateWithServerPropsOptions {
    enhanceContext?: Nilable<EnhanceServerContext<TContext>>;
    onError?: Nilable<ServerErrorHandler>;
}

Type Parameters

Properties

enhanceContext? +
interface ICreateWithServerPropsOptions {
    enhanceContext?: Nilable<EnhanceServerContext<TContext>>;
    onError?: Nilable<ServerErrorHandler>;
}

Type Parameters

Properties

enhanceContext? onError?

Properties

Optional enhanceContext

enhanceContext?: Nilable<EnhanceServerContext<TContext>>

The optional and custom function, that enhances the TContext based object.

-

Optional onError

onError?: Nilable<ServerErrorHandler>

Custom and additional error handler.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional onError

onError?: Nilable<ServerErrorHandler>

Custom and additional error handler.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IEnhanceApiContextExecutionContext.html b/interfaces/IEnhanceApiContextExecutionContext.html index b462d51..f02e0b0 100644 --- a/interfaces/IEnhanceApiContextExecutionContext.html +++ b/interfaces/IEnhanceApiContextExecutionContext.html @@ -1,9 +1,9 @@ IEnhanceApiContextExecutionContext | @egomobile/next-utils

Interface IEnhanceApiContextExecutionContext<TContext, TResponse>

Context for an EnhanceApiContext function.

-
interface IEnhanceApiContextExecutionContext {
    context: TContext;
    options: Nullable<Partial<IWithApiPropsOptions<TContext, TResponse>>>;
    shouldStop: boolean;
}

Type Parameters

Properties

context +
interface IEnhanceApiContextExecutionContext {
    context: TContext;
    options: Nullable<Partial<IWithApiPropsOptions<TContext, TResponse>>>;
    shouldStop: boolean;
}

Type Parameters

Properties

context options shouldStop

Properties

context

context: TContext

The context to enhance.

-

options

options: Nullable<Partial<IWithApiPropsOptions<TContext, TResponse>>>

The options.

-

shouldStop

shouldStop: boolean

Gets or sets if the execution should be stopped or not.

+

options

options: Nullable<Partial<IWithApiPropsOptions<TContext, TResponse>>>

The options.

+

shouldStop

shouldStop: boolean

Gets or sets if the execution should be stopped or not.

Default

false

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IEnhanceServerContextExecutionContext.html b/interfaces/IEnhanceServerContextExecutionContext.html index 9282b2b..241646a 100644 --- a/interfaces/IEnhanceServerContextExecutionContext.html +++ b/interfaces/IEnhanceServerContextExecutionContext.html @@ -1,11 +1,11 @@ IEnhanceServerContextExecutionContext | @egomobile/next-utils

Interface IEnhanceServerContextExecutionContext<TContext>

Context for an EnhanceServerContext function.

-
interface IEnhanceServerContextExecutionContext {
    context: TContext;
    options: Nullable<Partial<IWithServerPropsOptions>>;
    result: GetServerSidePropsResult<any>;
    shouldStop: boolean;
}

Type Parameters

Properties

context +
interface IEnhanceServerContextExecutionContext {
    context: TContext;
    options: Nullable<Partial<IWithServerPropsOptions>>;
    result: GetServerSidePropsResult<any>;
    shouldStop: boolean;
}

Type Parameters

Properties

context options result shouldStop

Properties

context

context: TContext

The context to enhance.

-

options

options: Nullable<Partial<IWithServerPropsOptions>>

The options.

-

result

result: GetServerSidePropsResult<any>

The props result.

-

shouldStop

shouldStop: boolean

Gets or sets if the execution should be stopped or not.

+

options

options: Nullable<Partial<IWithServerPropsOptions>>

The options.

+

result

result: GetServerSidePropsResult<any>

The props result.

+

shouldStop

shouldStop: boolean

Gets or sets if the execution should be stopped or not.

Default

false

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IGetApiPropsActionContext.html b/interfaces/IGetApiPropsActionContext.html index 3ee156d..40397c3 100644 --- a/interfaces/IGetApiPropsActionContext.html +++ b/interfaces/IGetApiPropsActionContext.html @@ -1,5 +1,5 @@ IGetApiPropsActionContext | @egomobile/next-utils

Interface IGetApiPropsActionContext<TResponse>

Context for a GetApiPropsAction action.

-
interface IGetApiPropsActionContext {
    request: NextApiRequest;
    response: NextApiResponse<TResponse>;
    sendConflict: ((message?) => void);
    sendData: ((data, code?) => void);
    sendForbidden: (() => void);
    sendList: ((items, code?) => void);
    sendNoContent: (() => void);
    sendNotFound: ((message) => void);
    sendValidationError: ((validationError) => void);
}

Type Parameters

  • TResponse = any

Properties

request +
interface IGetApiPropsActionContext {
    request: NextApiRequest;
    response: NextApiResponse<TResponse>;
    sendConflict: ((message?) => void);
    sendData: ((data, code?) => void);
    sendForbidden: (() => void);
    sendList: ((items, code?) => void);
    sendNoContent: (() => void);
    sendNotFound: ((message) => void);
    sendValidationError: ((validationError) => void);
}

Type Parameters

  • TResponse = any

Properties

request response sendConflict sendData @@ -9,19 +9,19 @@ sendNotFound sendValidationError

Properties

request

request: NextApiRequest

The request context.

-

response

response: NextApiResponse<TResponse>

The response context.

-

sendConflict

sendConflict: ((message?) => void)

Type declaration

response

response: NextApiResponse<TResponse>

The response context.

+

sendConflict

sendConflict: ((message?) => void)

Type declaration

    • (message?): void

    • Sends a standarized API 409 response.

      Parameters

      • Optional message: string

        The custom message. Default: 'Conflict'

        -

      Returns void

sendData

sendData: ((data, code?) => void)

Type declaration

    • (data, code?): void

    • Sends data on a standarized way.

      +

Returns void

sendData

sendData: ((data, code?) => void)

Type declaration

    • (data, code?): void

    • Sends data on a standarized way.

      Parameters

      • data: any

        The data to send.

      • Optional code: number

        The custom response status code.

        -

      Returns void

sendForbidden

sendForbidden: (() => void)

Type declaration

    • (): void

    • Sends a standarized API response for a forbidden resource.

      -

      Returns void

sendList

sendList: ((items, code?) => void)

Type declaration

    • (items, code?): void

    • Sends an standarized API response for a list.

      +

Returns void

sendForbidden

sendForbidden: (() => void)

Type declaration

    • (): void

    • Sends a standarized API response for a forbidden resource.

      +

      Returns void

sendList

sendList: ((items, code?) => void)

Type declaration

    • (items, code?): void

    • Sends an standarized API response for a list.

      Parameters

      • items: List<any>

        The items to send.

      • Optional code: number

        The custom response status code.

        -

      Returns void

sendNoContent

sendNoContent: (() => void)

Type declaration

    • (): void

    • Sends a 204 response.

      -

      Returns void

sendNotFound

sendNotFound: ((message) => void)

Type declaration

    • (message): void

    • Sends a standarized API 404 response.

      +

Returns void

sendNoContent

sendNoContent: (() => void)

Type declaration

sendNotFound

sendNotFound: ((message) => void)

Type declaration

sendValidationError

sendValidationError: ((validationError) => void)

Type declaration

Returns void

sendValidationError

sendValidationError: ((validationError) => void)

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IServerErrorHandlerContext.html b/interfaces/IServerErrorHandlerContext.html index b18e627..d465e76 100644 --- a/interfaces/IServerErrorHandlerContext.html +++ b/interfaces/IServerErrorHandlerContext.html @@ -1,11 +1,11 @@ IServerErrorHandlerContext | @egomobile/next-utils

Interface IServerErrorHandlerContext

A context for a server error handler.

-
interface IServerErrorHandlerContext {
    error: any;
    executeDefault: boolean;
    request: IncomingMessage;
    response: ServerResponse<IncomingMessage>;
}

Properties

error +
interface IServerErrorHandlerContext {
    error: any;
    executeDefault: boolean;
    request: IncomingMessage;
    response: ServerResponse<IncomingMessage>;
}

Properties

error executeDefault request response

Properties

error

error: any

The thrown error.

-

executeDefault

executeDefault: boolean

Also execute default logic or not.

+

executeDefault

executeDefault: boolean

Also execute default logic or not.

Default

true

-

request

request: IncomingMessage

The request context.

-

response

response: ServerResponse<IncomingMessage>

The response context.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

request

request: IncomingMessage

The request context.

+

response

response: ServerResponse<IncomingMessage>

The response context.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IUseUserResult.html b/interfaces/IUseUserResult.html index 3373ac9..204413d 100644 --- a/interfaces/IUseUserResult.html +++ b/interfaces/IUseUserResult.html @@ -1,5 +1,5 @@ IUseUserResult | @egomobile/next-utils

Interface IUseUserResult<TSessionProp>

Result of an useUser() hook.

-
interface IUseUserResult {
    displayName: Nullable<string>;
    groups: string[];
    hasGroup: UseUserHasGroupPredicate;
    hasPermission: UseUserHasPermissionPredicate;
    hasRole: UseUserHasRolePredicate;
    permissions: string[];
    photoUrl: Nullable<string>;
    roles: string[];
    session: Nullable<TSessionProp>;
}

Type Parameters

Properties

displayName +
interface IUseUserResult {
    displayName: Nullable<string>;
    groups: string[];
    hasGroup: UseUserHasGroupPredicate;
    hasPermission: UseUserHasPermissionPredicate;
    hasRole: UseUserHasRolePredicate;
    permissions: string[];
    photoUrl: Nullable<string>;
    roles: string[];
    session: Nullable<TSessionProp>;
}

Type Parameters

Properties

displayName groups hasGroup hasPermission @@ -9,12 +9,12 @@ roles session

Properties

displayName

displayName: Nullable<string>

The display name of the user, if available.

-

groups

groups: string[]

The list of groups the user belongs to. If no user is logged, this array is empty.

-

hasGroup

hasGroup: UseUserHasGroupPredicate

Checks for groups of current user. Alsways false if there is no user.

-

hasPermission

hasPermission: UseUserHasPermissionPredicate

Checks for permissions of current user. Alsways false if there is no user.

-

hasRole

hasRole: UseUserHasRolePredicate

Checks for roles of current user. Alsways false if there is no user.

-

permissions

permissions: string[]

The list of permissions the user belongs to. If no user is logged, this array is empty.

-

photoUrl

photoUrl: Nullable<string>

The URL of the avatar of the current user. null if there is no user.

-

roles

roles: string[]

The list of roles the user belongs to. If no user is logged, this array is empty.

-

session

session: Nullable<TSessionProp>

The current user session, if available.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

groups

groups: string[]

The list of groups the user belongs to. If no user is logged, this array is empty.

+

hasGroup

hasGroup: UseUserHasGroupPredicate

Checks for groups of current user. Alsways false if there is no user.

+

hasPermission

hasPermission: UseUserHasPermissionPredicate

Checks for permissions of current user. Alsways false if there is no user.

+

hasRole

hasRole: UseUserHasRolePredicate

Checks for roles of current user. Alsways false if there is no user.

+

permissions

permissions: string[]

The list of permissions the user belongs to. If no user is logged, this array is empty.

+

photoUrl

photoUrl: Nullable<string>

The URL of the avatar of the current user. null if there is no user.

+

roles

roles: string[]

The list of roles the user belongs to. If no user is logged, this array is empty.

+

session

session: Nullable<TSessionProp>

The current user session, if available.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IUserSessionProp.html b/interfaces/IUserSessionProp.html index 4c8487d..b079f6c 100644 --- a/interfaces/IUserSessionProp.html +++ b/interfaces/IUserSessionProp.html @@ -1,4 +1,4 @@ IUserSessionProp | @egomobile/next-utils

Interface IUserSessionProp

A basic structure of a user session prop.

-
interface IUserSessionProp {
    user: IUserSessionPropUser;
}

Properties

user +
interface IUserSessionProp {
    user: IUserSessionPropUser;
}

Properties

user

Properties

user

user: IUserSessionPropUser

Information about the current user.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IUserSessionPropUser.html b/interfaces/IUserSessionPropUser.html index b8ab522..1152344 100644 --- a/interfaces/IUserSessionPropUser.html +++ b/interfaces/IUserSessionPropUser.html @@ -1,12 +1,12 @@ IUserSessionPropUser | @egomobile/next-utils

Interface IUserSessionPropUser

User part of IUserSessionProp.

-
interface IUserSessionPropUser {
    displayName: string;
    groups: string[];
    id: string;
    permissions: string[];
    roles: string[];
}

Properties

displayName +
interface IUserSessionPropUser {
    displayName: string;
    groups: string[];
    id: string;
    permissions: string[];
    roles: string[];
}

Properties

displayName groups id permissions roles

Properties

displayName

displayName: string

The display name.

-

groups

groups: string[]

The list of groups.

-

id

id: string

The ID of the user.

-

permissions

permissions: string[]

The list of permissions.

-

roles

roles: string[]

The list of roles.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

groups

groups: string[]

The list of groups.

+

id

id: string

The ID of the user.

+

permissions

permissions: string[]

The list of permissions.

+

roles

roles: string[]

The list of roles.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IWithApiProps.html b/interfaces/IWithApiProps.html index 9b109ec..3048e8c 100644 --- a/interfaces/IWithApiProps.html +++ b/interfaces/IWithApiProps.html @@ -1,4 +1,4 @@ IWithApiProps | @egomobile/next-utils

Interface IWithApiProps

Contains props.

-
interface IWithApiProps {
    props: GetApiPropsActionProps;
}

Properties

props +
interface IWithApiProps {
    props: GetApiPropsActionProps;
}

Properties

props

Properties

props

props: GetApiPropsActionProps

The stored props.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IWithApiPropsOptions.html b/interfaces/IWithApiPropsOptions.html index 44b7a17..3e83e43 100644 --- a/interfaces/IWithApiPropsOptions.html +++ b/interfaces/IWithApiPropsOptions.html @@ -1,5 +1,5 @@ IWithApiPropsOptions | @egomobile/next-utils

Interface IWithApiPropsOptions<TContext, TResponse>

Options for a withApiProps() function call.

-
interface IWithApiPropsOptions {
    CONNECT: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    DELETE: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    GET: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    HEAD: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    OPTIONS: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    PATCH: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    POST: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    PUT: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    TRACE: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    getProps: GetApiPropsAction<TContext>;
    use: Nilable<ApiMiddleware[]>;
}

Type Parameters

Properties

CONNECT +
interface IWithApiPropsOptions {
    CONNECT: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    DELETE: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    GET: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    HEAD: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    OPTIONS: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    PATCH: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    POST: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    PUT: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    TRACE: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>;
    getProps: GetApiPropsAction<TContext>;
    use: Nilable<ApiMiddleware[]>;
}

Type Parameters

Properties

CONNECT DELETE GET HEAD @@ -11,14 +11,14 @@ getProps use

Properties

CONNECT

CONNECT: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a CONNECT request.

-

DELETE

DELETE: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a DELETE request.

-

GET

GET: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a GET request.

-

HEAD

HEAD: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a HEAD request.

-

OPTIONS

OPTIONS: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a OPTIONS request.

-

PATCH

PATCH: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a PATCH request.

-

POST

POST: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a POST request.

-

PUT

PUT: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a PUT request.

-

TRACE

TRACE: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a TRACE request.

-

getProps

getProps: GetApiPropsAction<TContext>

A function which returns the props for all WithApiPropsHandlers.

-

use

use: Nilable<ApiMiddleware[]>

One or more middlewares to use.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

DELETE

DELETE: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a DELETE request.

+

GET

GET: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a GET request.

+

HEAD

HEAD: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a HEAD request.

+

OPTIONS

OPTIONS: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a OPTIONS request.

+

PATCH

PATCH: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a PATCH request.

+

POST

POST: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a POST request.

+

PUT

PUT: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a PUT request.

+

TRACE

TRACE: Nilable<WithApiPropsHandler<TContext & IWithApiProps, TResponse>>

The action for a TRACE request.

+

getProps

getProps: GetApiPropsAction<TContext>

A function which returns the props for all WithApiPropsHandlers.

+

use

use: Nilable<ApiMiddleware[]>

One or more middlewares to use.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IWithServerPropsActionContext.html b/interfaces/IWithServerPropsActionContext.html index dca3b8e..a1be662 100644 --- a/interfaces/IWithServerPropsActionContext.html +++ b/interfaces/IWithServerPropsActionContext.html @@ -1,4 +1,4 @@ IWithServerPropsActionContext | @egomobile/next-utils

Interface IWithServerPropsActionContext

A context for a WithServerPropsAction action.

-
interface IWithServerPropsActionContext {
    nextContext: GetServerSidePropsContext<ParsedUrlQuery, PreviewData>;
}

Properties

nextContext +
interface IWithServerPropsActionContext {
    nextContext: GetServerSidePropsContext<ParsedUrlQuery, PreviewData>;
}

Properties

nextContext

Properties

nextContext

nextContext: GetServerSidePropsContext<ParsedUrlQuery, PreviewData>

The Next.js context.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IWithServerPropsOptions.html b/interfaces/IWithServerPropsOptions.html index 57d5220..dbb5144 100644 --- a/interfaces/IWithServerPropsOptions.html +++ b/interfaces/IWithServerPropsOptions.html @@ -1,4 +1,4 @@ IWithServerPropsOptions | @egomobile/next-utils

Interface IWithServerPropsOptions

Additional options for withServerProps() function.

-
interface IWithServerPropsOptions {
    use: Nilable<ServerMiddleware[]>;
}

Properties

use +
interface IWithServerPropsOptions {
    use: Nilable<ServerMiddleware[]>;
}

Properties

use

Properties

use

use: Nilable<ServerMiddleware[]>

One or more middlewares to use.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/modules.html b/modules.html index 72a1a6e..08430e2 100644 --- a/modules.html +++ b/modules.html @@ -1,4 +1,5 @@ @egomobile/next-utils

@egomobile/next-utils

Index

Classes

NextApiResponseBuilder +UnexpectedApiResponseError

Interfaces

ICreateUseUserSessionOptions ICreateUseUserSessionResult ICreateWithApiPropsOptions @@ -39,4 +40,5 @@

Functions

createUseUserSession createWithApiProps createWithServerProps -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +throwOnUnexpectedApiResponse +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ApiMiddleware.html b/types/ApiMiddleware.html index 3d48a30..5969850 100644 --- a/types/ApiMiddleware.html +++ b/types/ApiMiddleware.html @@ -2,4 +2,4 @@

Parameters

Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EnhanceApiContext.html b/types/EnhanceApiContext.html index 92a661f..1714ced 100644 --- a/types/EnhanceApiContext.html +++ b/types/EnhanceApiContext.html @@ -1,3 +1,3 @@ EnhanceApiContext | @egomobile/next-utils

Type alias EnhanceApiContext<TContext, TResponse>

EnhanceApiContext<TContext, TResponse>: ((context) => void | PromiseLike<void>)

Type Parameters

Type declaration

    • (context): void | PromiseLike<void>

    • Function that enhances an API context.

      Parameters

      Returns void | PromiseLike<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns void | PromiseLike<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EnhanceServerContext.html b/types/EnhanceServerContext.html index 328c74e..8b150b1 100644 --- a/types/EnhanceServerContext.html +++ b/types/EnhanceServerContext.html @@ -1,3 +1,3 @@ EnhanceServerContext | @egomobile/next-utils

Type alias EnhanceServerContext<TContext>

EnhanceServerContext<TContext>: ((context) => void | PromiseLike<void>)

Type Parameters

Type declaration

    • (context): void | PromiseLike<void>

    • Function that enhances a server context.

      Parameters

      Returns void | PromiseLike<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns void | PromiseLike<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/GetApiPropsAction.html b/types/GetApiPropsAction.html index 85a3b7b..4daa877 100644 --- a/types/GetApiPropsAction.html +++ b/types/GetApiPropsAction.html @@ -1,2 +1,2 @@ GetApiPropsAction | @egomobile/next-utils

Type alias GetApiPropsAction<TContext>

GetApiPropsAction<TContext>: ((context) => GetApiPropsActionResult)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns GetApiPropsActionResult

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/GetApiPropsActionErrorResultValue.html b/types/GetApiPropsActionErrorResultValue.html index f32a1f4..1aa0c97 100644 --- a/types/GetApiPropsActionErrorResultValue.html +++ b/types/GetApiPropsActionErrorResultValue.html @@ -1,2 +1,2 @@ GetApiPropsActionErrorResultValue | @egomobile/next-utils

Type alias GetApiPropsActionErrorResultValue

GetApiPropsActionErrorResultValue: true | string

Possible value for an "error prop" of a GetApiPropsActionResultValue instance.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/GetApiPropsActionProps.html b/types/GetApiPropsActionProps.html index 45ec142..a37fb5a 100644 --- a/types/GetApiPropsActionProps.html +++ b/types/GetApiPropsActionProps.html @@ -1,3 +1,3 @@ GetApiPropsActionProps | @egomobile/next-utils

Type alias GetApiPropsActionProps

GetApiPropsActionProps: Record<string, any>

Possible value for a props property of a non-error result of a GetApiPropsAction action.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/GetApiPropsActionResult.html b/types/GetApiPropsActionResult.html index ebf11f1..330cf34 100644 --- a/types/GetApiPropsActionResult.html +++ b/types/GetApiPropsActionResult.html @@ -1,2 +1,2 @@ GetApiPropsActionResult | @egomobile/next-utils

Type alias GetApiPropsActionResult

GetApiPropsActionResult: PromiseLike<GetApiPropsActionResultValue>

Possible result value of a GetApiPropsAction call.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/GetApiPropsActionResultValue.html b/types/GetApiPropsActionResultValue.html index b7fa0fe..810da10 100644 --- a/types/GetApiPropsActionResultValue.html +++ b/types/GetApiPropsActionResultValue.html @@ -1,2 +1,2 @@ GetApiPropsActionResultValue | @egomobile/next-utils

Type alias GetApiPropsActionResultValue

GetApiPropsActionResultValue: {
    props: GetApiPropsActionProps;
} | {
    badRequest: GetApiPropsActionErrorResultValue;
} | {
    notFound: GetApiPropsActionErrorResultValue;
}

Possible result value of a GetApiPropsAction call.

-

Type declaration

Type declaration

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type declaration

Type declaration

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/GetUserAvatarUrl.html b/types/GetUserAvatarUrl.html index 4ce9cc8..1005a32 100644 --- a/types/GetUserAvatarUrl.html +++ b/types/GetUserAvatarUrl.html @@ -1,4 +1,4 @@ GetUserAvatarUrl | @egomobile/next-utils

Type alias GetUserAvatarUrl<TSessionProp>

GetUserAvatarUrl<TSessionProp>: ((session) => Nullable<string>)

Type Parameters

Type declaration

    • (session): Nullable<string>

    • Returns a user avatar by session.

      Parameters

      • session: TSessionProp

        The current session.

      Returns Nullable<string>

      The URL or null if not available.

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/MiddlewareNextFunction.html b/types/MiddlewareNextFunction.html index 27c6954..b68f59d 100644 --- a/types/MiddlewareNextFunction.html +++ b/types/MiddlewareNextFunction.html @@ -1,3 +1,3 @@ MiddlewareNextFunction | @egomobile/next-utils

Type alias MiddlewareNextFunction

MiddlewareNextFunction: ((error?) => any)

Type declaration

    • (error?): any

    • A next function for a middleware.

      Parameters

      • Optional error: any

        The error, if occurred.

        -

      Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ServerErrorHandler.html b/types/ServerErrorHandler.html index cc80fe5..02f0d3a 100644 --- a/types/ServerErrorHandler.html +++ b/types/ServerErrorHandler.html @@ -1,3 +1,3 @@ ServerErrorHandler | @egomobile/next-utils

Type alias ServerErrorHandler

ServerErrorHandler: ((context) => any)

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ServerMiddleware.html b/types/ServerMiddleware.html index 8b508e8..7b7f851 100644 --- a/types/ServerMiddleware.html +++ b/types/ServerMiddleware.html @@ -2,4 +2,4 @@

Parameters

Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/UseUser.html b/types/UseUser.html index b136395..586ea43 100644 --- a/types/UseUser.html +++ b/types/UseUser.html @@ -1,3 +1,3 @@ UseUser | @egomobile/next-utils

Type alias UseUser<TSessionProp>

UseUser<TSessionProp>: (() => IUseUserResult<TSessionProp>)

Type Parameters

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/UseUserHasGroupPredicate.html b/types/UseUserHasGroupPredicate.html index 92ab6d4..ca282d0 100644 --- a/types/UseUserHasGroupPredicate.html +++ b/types/UseUserHasGroupPredicate.html @@ -1,4 +1,4 @@ UseUserHasGroupPredicate | @egomobile/next-utils

Type alias UseUserHasGroupPredicate

UseUserHasGroupPredicate: ((...groupsToCheck) => boolean)

Type declaration

    • (...groupsToCheck): boolean

    • A function that checks if current user is part of all groups.

      Parameters

      • Rest ...groupsToCheck: string[]

      Returns boolean

      Is part of all groupsToCheck or not.

      Params

      [groupsToCheck] Name of one or more groups to check.

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/UseUserHasPermissionPredicate.html b/types/UseUserHasPermissionPredicate.html index 063d519..4272770 100644 --- a/types/UseUserHasPermissionPredicate.html +++ b/types/UseUserHasPermissionPredicate.html @@ -1,4 +1,4 @@ UseUserHasPermissionPredicate | @egomobile/next-utils

Type alias UseUserHasPermissionPredicate

UseUserHasPermissionPredicate: ((...permissionsToCheck) => boolean)

Type declaration

    • (...permissionsToCheck): boolean

    • A function that checks if current user is part of all permissions.

      Parameters

      • Rest ...permissionsToCheck: string[]

      Returns boolean

      Is part of all permissionsToCheck or not.

      Params

      [permissionsToCheck] Name of one or more groups to check.

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/UseUserHasRolePredicate.html b/types/UseUserHasRolePredicate.html index bc6d719..6272486 100644 --- a/types/UseUserHasRolePredicate.html +++ b/types/UseUserHasRolePredicate.html @@ -1,4 +1,4 @@ UseUserHasRolePredicate | @egomobile/next-utils

Type alias UseUserHasRolePredicate

UseUserHasRolePredicate: ((...rolesToCheck) => boolean)

Type declaration

    • (...rolesToCheck): boolean

    • A function that checks if current user is part of all roles.

      Parameters

      • Rest ...rolesToCheck: string[]

      Returns boolean

      Is part of all rolesToCheck or not.

      Params

      [rolesToCheck] Name of one or more groups to check.

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/UseUserSession.html b/types/UseUserSession.html index 0db0852..0a15db2 100644 --- a/types/UseUserSession.html +++ b/types/UseUserSession.html @@ -1,4 +1,4 @@ UseUserSession | @egomobile/next-utils

Type alias UseUserSession<TSessionProp>

UseUserSession<TSessionProp>: ((required?) => Nullable<TSessionProp>)

Type Parameters

Type declaration

    • (required?): Nullable<TSessionProp>

    • Structure of a useUserSession hook.

      Parameters

      • Optional required: Optional<boolean>

        If true, an exception is throw if no session is available, otherwise null will be returned.

      Returns Nullable<TSessionProp>

      The session or null if there is no session.

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/WithApiPropsFactory.html b/types/WithApiPropsFactory.html index 8bb6355..30250e8 100644 --- a/types/WithApiPropsFactory.html +++ b/types/WithApiPropsFactory.html @@ -2,4 +2,4 @@ that is used for API endpoints in Next.js.

Type Parameters

Parameters

Returns NextApiHandler<TResponse>

The new function.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/WithApiPropsHandler.html b/types/WithApiPropsHandler.html index 6d2ee17..976eb51 100644 --- a/types/WithApiPropsHandler.html +++ b/types/WithApiPropsHandler.html @@ -1,4 +1,4 @@ WithApiPropsHandler | @egomobile/next-utils

Type alias WithApiPropsHandler<TContext, TResponse>

WithApiPropsHandler<TContext, TResponse>: ((context) => PromiseLike<TResponse>)

Type Parameters

Type declaration

    • (context): PromiseLike<TResponse>

    • A handler of a "method prop" instide an IWithApiPropsOptions instance.

      Parameters

      • context: TContext

        The context.

      Returns PromiseLike<TResponse>

      The promise with the response data.

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/WithServerPropsAction.html b/types/WithServerPropsAction.html index a9c6d57..24c1a74 100644 --- a/types/WithServerPropsAction.html +++ b/types/WithServerPropsAction.html @@ -1,3 +1,3 @@ WithServerPropsAction | @egomobile/next-utils

Type alias WithServerPropsAction<TContext>

WithServerPropsAction<TContext>: ((context) => Promise<GetServerSidePropsResult<any>>)

Type Parameters

Type declaration

    • (context): Promise<GetServerSidePropsResult<any>>

    • An action for a withServerProps() call.

      Parameters

      • context: TContext

        The context.

        -

      Returns Promise<GetServerSidePropsResult<any>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<GetServerSidePropsResult<any>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/WithServerPropsFactory.html b/types/WithServerPropsFactory.html index dceba77..c8d40a1 100644 --- a/types/WithServerPropsFactory.html +++ b/types/WithServerPropsFactory.html @@ -3,4 +3,4 @@

Parameters

Returns GetServerSideProps

The new function.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/schema.html b/variables/schema.html index e5c438c..c183e42 100644 --- a/variables/schema.html +++ b/variables/schema.html @@ -1,2 +1,2 @@ schema | @egomobile/next-utils

Variable schemaConst

schema: Root = ...

Alias for 'joi' module.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file