From 801c948aadfa0041a7870accc0644efb4a31145d Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Fri, 9 Jun 2023 21:51:10 +0200 Subject: [PATCH] docs: cleanups MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- pnpm-lock.yaml | 57 +++++++++++++++++++------------------- src/pools/abstract-pool.ts | 2 -- src/pools/cluster/fixed.ts | 2 -- src/pools/thread/fixed.ts | 2 -- 4 files changed, 28 insertions(+), 35 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index d5427708..166662ca 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -154,23 +154,23 @@ packages: fast-deep-equal: 3.1.3 dev: true - /@babel/code-frame@7.21.4: - resolution: {integrity: sha512-LYvhNKfwWSPpocw8GI7gpK2nq3HSDuEPC/uSYaALSJu9xjsalaaYFOq0Pwt5KmVqwEbZlDu81aLXwBOmD/Fv9g==} + /@babel/code-frame@7.22.5: + resolution: {integrity: sha512-Xmwn266vad+6DAqEB2A6V/CcZVp62BbwVmcOJc2RPuwih1kw02TjQvWVWlcKGbBPd+8/0V5DEkOcizRGYsspYQ==} engines: {node: '>=6.9.0'} dependencies: - '@babel/highlight': 7.18.6 + '@babel/highlight': 7.22.5 dev: true - /@babel/helper-validator-identifier@7.19.1: - resolution: {integrity: sha512-awrNfaMtnHUr653GgGEs++LlAvW6w+DcPrOliSMXWCKo597CwL5Acf/wWdNkf/tfEQE3mjkeD1YOVZOUV/od1w==} + /@babel/helper-validator-identifier@7.22.5: + resolution: {integrity: sha512-aJXu+6lErq8ltp+JhkJUfk1MTGyuA4v7f3pA+BJ5HLfNC6nAQ0Cpi9uOquUj8Hehg0aUiHzWQbOVJGao6ztBAQ==} engines: {node: '>=6.9.0'} dev: true - /@babel/highlight@7.18.6: - resolution: {integrity: sha512-u7stbOuYjaPezCuLj29hNW1v64M2Md2qupEKP1fHc7WdOA3DgLh37suiSrZYY7haUB7iBeQZ9P1uiRF359do3g==} + /@babel/highlight@7.22.5: + resolution: {integrity: sha512-BSKlD1hgnedS5XRnGOljZawtag7H1yPfQp0tdNJCHoH6AZ+Pcm9VvkrK59/Yy593Ypg0zMxH2BxD1VPYUQ7UIw==} engines: {node: '>=6.9.0'} dependencies: - '@babel/helper-validator-identifier': 7.19.1 + '@babel/helper-validator-identifier': 7.22.5 chalk: 2.4.2 js-tokens: 4.0.0 dev: true @@ -555,18 +555,18 @@ packages: '@octokit/graphql': 5.0.6 '@octokit/request': 6.2.5 '@octokit/request-error': 3.0.3 - '@octokit/types': 9.2.3 + '@octokit/types': 9.3.0 before-after-hook: 2.2.3 universal-user-agent: 6.0.0 transitivePeerDependencies: - encoding dev: true - /@octokit/endpoint@7.0.5: - resolution: {integrity: sha512-LG4o4HMY1Xoaec87IqQ41TQ+glvIeTKqfjkCEmt5AIwDZJwQeVZFIEYXrYY6yLwK+pAScb9Gj4q+Nz2qSw1roA==} + /@octokit/endpoint@7.0.6: + resolution: {integrity: sha512-5L4fseVRUsDFGR00tMWD/Trdeeihn999rTMGRMC1G/Ldi1uWlWJzI98H4Iak5DB/RVvQuyMYKqSK/R6mbSOQyg==} engines: {node: '>= 14'} dependencies: - '@octokit/types': 9.2.3 + '@octokit/types': 9.3.0 is-plain-object: 5.0.0 universal-user-agent: 6.0.0 dev: true @@ -576,14 +576,14 @@ packages: engines: {node: '>= 14'} dependencies: '@octokit/request': 6.2.5 - '@octokit/types': 9.2.3 + '@octokit/types': 9.3.0 universal-user-agent: 6.0.0 transitivePeerDependencies: - encoding dev: true - /@octokit/openapi-types@17.2.0: - resolution: {integrity: sha512-MazrFNx4plbLsGl+LFesMo96eIXkFgEtaKbnNpdh4aQ0VM10aoylFsTYP1AEjkeoRNZiiPe3T6Gl2Hr8dJWdlQ==} + /@octokit/openapi-types@18.0.0: + resolution: {integrity: sha512-V8GImKs3TeQRxRtXFpG2wl19V7444NIOTDF24AWuIbmNaNYOQMWRbjcGDXV5B+0n887fgDcuMNOmlul+k+oJtw==} dev: true /@octokit/plugin-paginate-rest@6.1.2(@octokit/core@4.2.1): @@ -594,7 +594,7 @@ packages: dependencies: '@octokit/core': 4.2.1 '@octokit/tsconfig': 1.0.2 - '@octokit/types': 9.2.3 + '@octokit/types': 9.3.0 dev: true /@octokit/plugin-request-log@1.0.4(@octokit/core@4.2.1): @@ -605,22 +605,21 @@ packages: '@octokit/core': 4.2.1 dev: true - /@octokit/plugin-rest-endpoint-methods@7.1.2(@octokit/core@4.2.1): - resolution: {integrity: sha512-R0oJ7j6f/AdqPLtB9qRXLO+wjI9pctUn8Ka8UGfGaFCcCv3Otx14CshQ89K4E88pmyYZS8p0rNTiprML/81jig==} + /@octokit/plugin-rest-endpoint-methods@7.2.0(@octokit/core@4.2.1): + resolution: {integrity: sha512-yZhsKs8QnQbEpeAUd0WGgNJLoVHzENir7H0JmZg9BWRCZB+Fmqj7x/+sUFK7kw24XjWWVIQ4qGswps42/lmiIQ==} engines: {node: '>= 14'} peerDependencies: '@octokit/core': '>=3' dependencies: '@octokit/core': 4.2.1 - '@octokit/types': 9.2.3 - deprecation: 2.3.1 + '@octokit/types': 9.3.0 dev: true /@octokit/request-error@3.0.3: resolution: {integrity: sha512-crqw3V5Iy2uOU5Np+8M/YexTlT8zxCfI+qu+LxUB7SZpje4Qmx3mub5DfEKSO8Ylyk0aogi6TYdf6kxzh2BguQ==} engines: {node: '>= 14'} dependencies: - '@octokit/types': 9.2.3 + '@octokit/types': 9.3.0 deprecation: 2.3.1 once: 1.4.0 dev: true @@ -629,9 +628,9 @@ packages: resolution: {integrity: sha512-z83E8UIlPNaJUsXpjD8E0V5o/5f+vJJNbNcBwVZsX3/vC650U41cOkTLjq4PKk9BYonQGOnx7N17gvLyNjgGcQ==} engines: {node: '>= 14'} dependencies: - '@octokit/endpoint': 7.0.5 + '@octokit/endpoint': 7.0.6 '@octokit/request-error': 3.0.3 - '@octokit/types': 9.2.3 + '@octokit/types': 9.3.0 is-plain-object: 5.0.0 node-fetch: 2.6.11 universal-user-agent: 6.0.0 @@ -646,7 +645,7 @@ packages: '@octokit/core': 4.2.1 '@octokit/plugin-paginate-rest': 6.1.2(@octokit/core@4.2.1) '@octokit/plugin-request-log': 1.0.4(@octokit/core@4.2.1) - '@octokit/plugin-rest-endpoint-methods': 7.1.2(@octokit/core@4.2.1) + '@octokit/plugin-rest-endpoint-methods': 7.2.0(@octokit/core@4.2.1) transitivePeerDependencies: - encoding dev: true @@ -655,10 +654,10 @@ packages: resolution: {integrity: sha512-I0vDR0rdtP8p2lGMzvsJzbhdOWy405HcGovrspJ8RRibHnyRgggUSNO5AIox5LmqiwmatHKYsvj6VGFHkqS7lA==} dev: true - /@octokit/types@9.2.3: - resolution: {integrity: sha512-MMeLdHyFIALioycq+LFcA71v0S2xpQUX2cw6pPbHQjaibcHYwLnmK/kMZaWuGfGfjBJZ3wRUq+dOaWsvrPJVvA==} + /@octokit/types@9.3.0: + resolution: {integrity: sha512-ZNO1In0QuWZLDngSLcn5H4ExRhYOd1rDcWnwc/LuR55cO1d6Sex6+T6RiSQwp/tyEg7eNWx+MUdJGL7Fu1kMjw==} dependencies: - '@octokit/openapi-types': 17.2.0 + '@octokit/openapi-types': 18.0.0 dev: true /@pkgr/utils@2.4.1: @@ -3678,7 +3677,7 @@ packages: resolution: {integrity: sha512-Kijeg9Dag6CKtIDA7O21zNTACqD5MD/8HfIV8pdD94vFyFuer52SigdC3IQMhab3vACxXMiFk+yMHNdbqtyTGA==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@babel/code-frame': 7.21.4 + '@babel/code-frame': 7.22.5 '@jest/types': 29.5.0 '@types/stack-utils': 2.0.1 chalk: 4.1.2 @@ -4693,7 +4692,7 @@ packages: resolution: {integrity: sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==} engines: {node: '>=8'} dependencies: - '@babel/code-frame': 7.21.4 + '@babel/code-frame': 7.22.5 error-ex: 1.3.2 json-parse-even-better-errors: 2.3.1 lines-and-columns: 1.2.4 diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 427678c4..fa084fa1 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -68,8 +68,6 @@ export abstract class AbstractPool< /** * Worker choice strategy context referencing a worker choice algorithm implementation. - * - * Default to a round robin algorithm. */ protected workerChoiceStrategyContext: WorkerChoiceStrategyContext< Worker, diff --git a/src/pools/cluster/fixed.ts b/src/pools/cluster/fixed.ts index 592b3fe7..a13a95ce 100644 --- a/src/pools/cluster/fixed.ts +++ b/src/pools/cluster/fixed.ts @@ -32,8 +32,6 @@ export interface ClusterPoolOptions extends PoolOptions { * * It is possible to perform tasks in sync or asynchronous mode as you prefer. * - * This pool selects the workers in a round robin fashion. - * * @typeParam Data - Type of data sent to the worker. This can only be serializable data. * @typeParam Response - Type of execution response. This can only be serializable data. * @author [Christopher Quadflieg](https://github.com/Shinigami92) diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts index a9d8f685..d843144c 100644 --- a/src/pools/thread/fixed.ts +++ b/src/pools/thread/fixed.ts @@ -37,8 +37,6 @@ export type ThreadWorkerWithMessageChannel = Worker & Draft * * It is possible to perform tasks in sync or asynchronous mode as you prefer. * - * This pool selects the threads in a round robin fashion. - * * @typeParam Data - Type of data sent to the worker. This can only be serializable data. * @typeParam Response - Type of execution response. This can only be serializable data. * @author [Alessandro Pio Ardizio](https://github.com/pioardi) -- 2.34.1