node-screenshots
Advanced tools
+64
-15
@@ -6,17 +6,66 @@ /* tslint:disable */ | ||
| export class Screenshots { | ||
| id: number | ||
| x: number | ||
| y: number | ||
| width: number | ||
| height: number | ||
| rotation: number | ||
| scaleFactor: number | ||
| isPrimary: boolean | ||
| static all(): Array<Screenshots> | ||
| static fromPoint(x: number, y: number): Screenshots | null | ||
| captureSync(copyOutputData?: boolean | undefined | null): Buffer | ||
| capture(copyOutputData?: boolean | undefined | null): Promise<Buffer> | ||
| captureAreaSync(x: number, y: number, width: number, height: number, copyOutputData?: boolean | undefined | null): Buffer | ||
| captureArea(x: number, y: number, width: number, height: number, copyOutputData?: boolean | undefined | null): Promise<Buffer> | ||
| export class Image { | ||
| readonly width: number | ||
| readonly height: number | ||
| cropSync(x: number, y: number, width: number, height: number): Image | ||
| crop(x: number, y: number, width: number, height: number): Promise<Image> | ||
| toPngSync(copyOutputData?: boolean | undefined | null): Buffer | ||
| toPng(copyOutputData?: boolean | undefined | null): Promise<Buffer> | ||
| toJpegSync(copyOutputData?: boolean | undefined | null): Buffer | ||
| toJpeg(copyOutputData?: boolean | undefined | null): Promise<Buffer> | ||
| toBmpSync(copyOutputData?: boolean | undefined | null): Buffer | ||
| toBmp(copyOutputData?: boolean | undefined | null): Promise<Buffer> | ||
| toRawSync(copyOutputData?: boolean | undefined | null): Buffer | ||
| toRaw(copyOutputData?: boolean | undefined | null): Promise<Buffer> | ||
| } | ||
| export class Monitor { | ||
| /** Unique identifier associated with the screen. */ | ||
| readonly id: number | ||
| /** Unique identifier associated with the screen. */ | ||
| readonly name: string | ||
| /** The screen x coordinate. */ | ||
| readonly x: number | ||
| /** The screen x coordinate. */ | ||
| readonly y: number | ||
| /** The screen pixel width. */ | ||
| readonly width: number | ||
| /** The screen pixel height. */ | ||
| readonly height: number | ||
| /** Can be 0, 90, 180, 270, represents screen rotation in clock-wise degrees. */ | ||
| readonly rotation: number | ||
| /** Output device's pixel scale factor. */ | ||
| readonly scaleFactor: number | ||
| /** The screen refresh rate. */ | ||
| readonly frequency: number | ||
| /** Whether the screen is the main screen */ | ||
| readonly isPrimary: boolean | ||
| static all(): Array<Monitor> | ||
| static fromPoint(x: number, y: number): Monitor | null | ||
| captureImageSync(): Image | ||
| captureImage(): Promise<Image> | ||
| } | ||
| export class Window { | ||
| /** The window id */ | ||
| readonly id: number | ||
| /** The window app name */ | ||
| readonly appName: string | ||
| /** The window title */ | ||
| readonly title: string | ||
| /** The window current monitor */ | ||
| readonly currentMonitor: Monitor | ||
| /** The window x coordinate. */ | ||
| readonly x: number | ||
| /** The window x coordinate. */ | ||
| readonly y: number | ||
| /** The window pixel width. */ | ||
| readonly width: number | ||
| /** The window pixel height. */ | ||
| readonly height: number | ||
| /** The window is minimized. */ | ||
| readonly isMinimized: boolean | ||
| /** The window is maximized. */ | ||
| readonly isMaximized: boolean | ||
| static all(): Array<Window> | ||
| captureImageSync(): Image | ||
| captureImage(): Promise<Image> | ||
| } |
+65
-5
@@ -227,10 +227,68 @@ /* tslint:disable */ | ||
| case 'arm': | ||
| if (isMusl()) { | ||
| localFileExisted = existsSync( | ||
| join(__dirname, 'node-screenshots.linux-arm-musleabihf.node') | ||
| ) | ||
| try { | ||
| if (localFileExisted) { | ||
| nativeBinding = require('./node-screenshots.linux-arm-musleabihf.node') | ||
| } else { | ||
| nativeBinding = require('node-screenshots-linux-arm-musleabihf') | ||
| } | ||
| } catch (e) { | ||
| loadError = e | ||
| } | ||
| } else { | ||
| localFileExisted = existsSync( | ||
| join(__dirname, 'node-screenshots.linux-arm-gnueabihf.node') | ||
| ) | ||
| try { | ||
| if (localFileExisted) { | ||
| nativeBinding = require('./node-screenshots.linux-arm-gnueabihf.node') | ||
| } else { | ||
| nativeBinding = require('node-screenshots-linux-arm-gnueabihf') | ||
| } | ||
| } catch (e) { | ||
| loadError = e | ||
| } | ||
| } | ||
| break | ||
| case 'riscv64': | ||
| if (isMusl()) { | ||
| localFileExisted = existsSync( | ||
| join(__dirname, 'node-screenshots.linux-riscv64-musl.node') | ||
| ) | ||
| try { | ||
| if (localFileExisted) { | ||
| nativeBinding = require('./node-screenshots.linux-riscv64-musl.node') | ||
| } else { | ||
| nativeBinding = require('node-screenshots-linux-riscv64-musl') | ||
| } | ||
| } catch (e) { | ||
| loadError = e | ||
| } | ||
| } else { | ||
| localFileExisted = existsSync( | ||
| join(__dirname, 'node-screenshots.linux-riscv64-gnu.node') | ||
| ) | ||
| try { | ||
| if (localFileExisted) { | ||
| nativeBinding = require('./node-screenshots.linux-riscv64-gnu.node') | ||
| } else { | ||
| nativeBinding = require('node-screenshots-linux-riscv64-gnu') | ||
| } | ||
| } catch (e) { | ||
| loadError = e | ||
| } | ||
| } | ||
| break | ||
| case 's390x': | ||
| localFileExisted = existsSync( | ||
| join(__dirname, 'node-screenshots.linux-arm-gnueabihf.node') | ||
| join(__dirname, 'node-screenshots.linux-s390x-gnu.node') | ||
| ) | ||
| try { | ||
| if (localFileExisted) { | ||
| nativeBinding = require('./node-screenshots.linux-arm-gnueabihf.node') | ||
| nativeBinding = require('./node-screenshots.linux-s390x-gnu.node') | ||
| } else { | ||
| nativeBinding = require('node-screenshots-linux-arm-gnueabihf') | ||
| nativeBinding = require('node-screenshots-linux-s390x-gnu') | ||
| } | ||
@@ -256,4 +314,6 @@ } catch (e) { | ||
| const { Screenshots } = nativeBinding | ||
| const { Image, Monitor, Window } = nativeBinding | ||
| module.exports.Screenshots = Screenshots | ||
| module.exports.Image = Image | ||
| module.exports.Monitor = Monitor | ||
| module.exports.Window = Window |
+157
-157
@@ -5,176 +5,176 @@ Apache License | ||
| TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
| TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
| 1. Definitions. | ||
| 1. Definitions. | ||
| "License" shall mean the terms and conditions for use, reproduction, | ||
| and distribution as defined by Sections 1 through 9 of this document. | ||
| "License" shall mean the terms and conditions for use, reproduction, | ||
| and distribution as defined by Sections 1 through 9 of this document. | ||
| "Licensor" shall mean the copyright owner or entity authorized by | ||
| the copyright owner that is granting the License. | ||
| "Licensor" shall mean the copyright owner or entity authorized by | ||
| the copyright owner that is granting the License. | ||
| "Legal Entity" shall mean the union of the acting entity and all | ||
| other entities that control, are controlled by, or are under common | ||
| control with that entity. For the purposes of this definition, | ||
| "control" means (i) the power, direct or indirect, to cause the | ||
| direction or management of such entity, whether by contract or | ||
| otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
| outstanding shares, or (iii) beneficial ownership of such entity. | ||
| "Legal Entity" shall mean the union of the acting entity and all | ||
| other entities that control, are controlled by, or are under common | ||
| control with that entity. For the purposes of this definition, | ||
| "control" means (i) the power, direct or indirect, to cause the | ||
| direction or management of such entity, whether by contract or | ||
| otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
| outstanding shares, or (iii) beneficial ownership of such entity. | ||
| "You" (or "Your") shall mean an individual or Legal Entity | ||
| exercising permissions granted by this License. | ||
| "You" (or "Your") shall mean an individual or Legal Entity | ||
| exercising permissions granted by this License. | ||
| "Source" form shall mean the preferred form for making modifications, | ||
| including but not limited to software source code, documentation | ||
| source, and configuration files. | ||
| "Source" form shall mean the preferred form for making modifications, | ||
| including but not limited to software source code, documentation | ||
| source, and configuration files. | ||
| "Object" form shall mean any form resulting from mechanical | ||
| transformation or translation of a Source form, including but | ||
| not limited to compiled object code, generated documentation, | ||
| and conversions to other media types. | ||
| "Object" form shall mean any form resulting from mechanical | ||
| transformation or translation of a Source form, including but | ||
| not limited to compiled object code, generated documentation, | ||
| and conversions to other media types. | ||
| "Work" shall mean the work of authorship, whether in Source or | ||
| Object form, made available under the License, as indicated by a | ||
| copyright notice that is included in or attached to the work | ||
| (an example is provided in the Appendix below). | ||
| "Work" shall mean the work of authorship, whether in Source or | ||
| Object form, made available under the License, as indicated by a | ||
| copyright notice that is included in or attached to the work | ||
| (an example is provided in the Appendix below). | ||
| "Derivative Works" shall mean any work, whether in Source or Object | ||
| form, that is based on (or derived from) the Work and for which the | ||
| editorial revisions, annotations, elaborations, or other modifications | ||
| represent, as a whole, an original work of authorship. For the purposes | ||
| of this License, Derivative Works shall not include works that remain | ||
| separable from, or merely link (or bind by name) to the interfaces of, | ||
| the Work and Derivative Works thereof. | ||
| "Derivative Works" shall mean any work, whether in Source or Object | ||
| form, that is based on (or derived from) the Work and for which the | ||
| editorial revisions, annotations, elaborations, or other modifications | ||
| represent, as a whole, an original work of authorship. For the purposes | ||
| of this License, Derivative Works shall not include works that remain | ||
| separable from, or merely link (or bind by name) to the interfaces of, | ||
| the Work and Derivative Works thereof. | ||
| "Contribution" shall mean any work of authorship, including | ||
| the original version of the Work and any modifications or additions | ||
| to that Work or Derivative Works thereof, that is intentionally | ||
| submitted to Licensor for inclusion in the Work by the copyright owner | ||
| or by an individual or Legal Entity authorized to submit on behalf of | ||
| the copyright owner. For the purposes of this definition, "submitted" | ||
| means any form of electronic, verbal, or written communication sent | ||
| to the Licensor or its representatives, including but not limited to | ||
| communication on electronic mailing lists, source code control systems, | ||
| and issue tracking systems that are managed by, or on behalf of, the | ||
| Licensor for the purpose of discussing and improving the Work, but | ||
| excluding communication that is conspicuously marked or otherwise | ||
| designated in writing by the copyright owner as "Not a Contribution." | ||
| "Contribution" shall mean any work of authorship, including | ||
| the original version of the Work and any modifications or additions | ||
| to that Work or Derivative Works thereof, that is intentionally | ||
| submitted to Licensor for inclusion in the Work by the copyright owner | ||
| or by an individual or Legal Entity authorized to submit on behalf of | ||
| the copyright owner. For the purposes of this definition, "submitted" | ||
| means any form of electronic, verbal, or written communication sent | ||
| to the Licensor or its representatives, including but not limited to | ||
| communication on electronic mailing lists, source code control systems, | ||
| and issue tracking systems that are managed by, or on behalf of, the | ||
| Licensor for the purpose of discussing and improving the Work, but | ||
| excluding communication that is conspicuously marked or otherwise | ||
| designated in writing by the copyright owner as "Not a Contribution." | ||
| "Contributor" shall mean Licensor and any individual or Legal Entity | ||
| on behalf of whom a Contribution has been received by Licensor and | ||
| subsequently incorporated within the Work. | ||
| "Contributor" shall mean Licensor and any individual or Legal Entity | ||
| on behalf of whom a Contribution has been received by Licensor and | ||
| subsequently incorporated within the Work. | ||
| 2. Grant of Copyright License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| copyright license to reproduce, prepare Derivative Works of, | ||
| publicly display, publicly perform, sublicense, and distribute the | ||
| Work and such Derivative Works in Source or Object form. | ||
| 2. Grant of Copyright License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| copyright license to reproduce, prepare Derivative Works of, | ||
| publicly display, publicly perform, sublicense, and distribute the | ||
| Work and such Derivative Works in Source or Object form. | ||
| 3. Grant of Patent License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| (except as stated in this section) patent license to make, have made, | ||
| use, offer to sell, sell, import, and otherwise transfer the Work, | ||
| where such license applies only to those patent claims licensable | ||
| by such Contributor that are necessarily infringed by their | ||
| Contribution(s) alone or by combination of their Contribution(s) | ||
| with the Work to which such Contribution(s) was submitted. If You | ||
| institute patent litigation against any entity (including a | ||
| cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
| or a Contribution incorporated within the Work constitutes direct | ||
| or contributory patent infringement, then any patent licenses | ||
| granted to You under this License for that Work shall terminate | ||
| as of the date such litigation is filed. | ||
| 3. Grant of Patent License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| (except as stated in this section) patent license to make, have made, | ||
| use, offer to sell, sell, import, and otherwise transfer the Work, | ||
| where such license applies only to those patent claims licensable | ||
| by such Contributor that are necessarily infringed by their | ||
| Contribution(s) alone or by combination of their Contribution(s) | ||
| with the Work to which such Contribution(s) was submitted. If You | ||
| institute patent litigation against any entity (including a | ||
| cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
| or a Contribution incorporated within the Work constitutes direct | ||
| or contributory patent infringement, then any patent licenses | ||
| granted to You under this License for that Work shall terminate | ||
| as of the date such litigation is filed. | ||
| 4. Redistribution. You may reproduce and distribute copies of the | ||
| Work or Derivative Works thereof in any medium, with or without | ||
| modifications, and in Source or Object form, provided that You | ||
| meet the following conditions: | ||
| 4. Redistribution. You may reproduce and distribute copies of the | ||
| Work or Derivative Works thereof in any medium, with or without | ||
| modifications, and in Source or Object form, provided that You | ||
| meet the following conditions: | ||
| (a) You must give any other recipients of the Work or | ||
| Derivative Works a copy of this License; and | ||
| (a) You must give any other recipients of the Work or | ||
| Derivative Works a copy of this License; and | ||
| (b) You must cause any modified files to carry prominent notices | ||
| stating that You changed the files; and | ||
| (b) You must cause any modified files to carry prominent notices | ||
| stating that You changed the files; and | ||
| (c) You must retain, in the Source form of any Derivative Works | ||
| that You distribute, all copyright, patent, trademark, and | ||
| attribution notices from the Source form of the Work, | ||
| excluding those notices that do not pertain to any part of | ||
| the Derivative Works; and | ||
| (c) You must retain, in the Source form of any Derivative Works | ||
| that You distribute, all copyright, patent, trademark, and | ||
| attribution notices from the Source form of the Work, | ||
| excluding those notices that do not pertain to any part of | ||
| the Derivative Works; and | ||
| (d) If the Work includes a "NOTICE" text file as part of its | ||
| distribution, then any Derivative Works that You distribute must | ||
| include a readable copy of the attribution notices contained | ||
| within such NOTICE file, excluding those notices that do not | ||
| pertain to any part of the Derivative Works, in at least one | ||
| of the following places: within a NOTICE text file distributed | ||
| as part of the Derivative Works; within the Source form or | ||
| documentation, if provided along with the Derivative Works; or, | ||
| within a display generated by the Derivative Works, if and | ||
| wherever such third-party notices normally appear. The contents | ||
| of the NOTICE file are for informational purposes only and | ||
| do not modify the License. You may add Your own attribution | ||
| notices within Derivative Works that You distribute, alongside | ||
| or as an addendum to the NOTICE text from the Work, provided | ||
| that such additional attribution notices cannot be construed | ||
| as modifying the License. | ||
| (d) If the Work includes a "NOTICE" text file as part of its | ||
| distribution, then any Derivative Works that You distribute must | ||
| include a readable copy of the attribution notices contained | ||
| within such NOTICE file, excluding those notices that do not | ||
| pertain to any part of the Derivative Works, in at least one | ||
| of the following places: within a NOTICE text file distributed | ||
| as part of the Derivative Works; within the Source form or | ||
| documentation, if provided along with the Derivative Works; or, | ||
| within a display generated by the Derivative Works, if and | ||
| wherever such third-party notices normally appear. The contents | ||
| of the NOTICE file are for informational purposes only and | ||
| do not modify the License. You may add Your own attribution | ||
| notices within Derivative Works that You distribute, alongside | ||
| or as an addendum to the NOTICE text from the Work, provided | ||
| that such additional attribution notices cannot be construed | ||
| as modifying the License. | ||
| You may add Your own copyright statement to Your modifications and | ||
| may provide additional or different license terms and conditions | ||
| for use, reproduction, or distribution of Your modifications, or | ||
| for any such Derivative Works as a whole, provided Your use, | ||
| reproduction, and distribution of the Work otherwise complies with | ||
| the conditions stated in this License. | ||
| You may add Your own copyright statement to Your modifications and | ||
| may provide additional or different license terms and conditions | ||
| for use, reproduction, or distribution of Your modifications, or | ||
| for any such Derivative Works as a whole, provided Your use, | ||
| reproduction, and distribution of the Work otherwise complies with | ||
| the conditions stated in this License. | ||
| 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
| any Contribution intentionally submitted for inclusion in the Work | ||
| by You to the Licensor shall be under the terms and conditions of | ||
| this License, without any additional terms or conditions. | ||
| Notwithstanding the above, nothing herein shall supersede or modify | ||
| the terms of any separate license agreement you may have executed | ||
| with Licensor regarding such Contributions. | ||
| 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
| any Contribution intentionally submitted for inclusion in the Work | ||
| by You to the Licensor shall be under the terms and conditions of | ||
| this License, without any additional terms or conditions. | ||
| Notwithstanding the above, nothing herein shall supersede or modify | ||
| the terms of any separate license agreement you may have executed | ||
| with Licensor regarding such Contributions. | ||
| 6. Trademarks. This License does not grant permission to use the trade | ||
| names, trademarks, service marks, or product names of the Licensor, | ||
| except as required for reasonable and customary use in describing the | ||
| origin of the Work and reproducing the content of the NOTICE file. | ||
| 6. Trademarks. This License does not grant permission to use the trade | ||
| names, trademarks, service marks, or product names of the Licensor, | ||
| except as required for reasonable and customary use in describing the | ||
| origin of the Work and reproducing the content of the NOTICE file. | ||
| 7. Disclaimer of Warranty. Unless required by applicable law or | ||
| agreed to in writing, Licensor provides the Work (and each | ||
| Contributor provides its Contributions) on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| implied, including, without limitation, any warranties or conditions | ||
| of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
| PARTICULAR PURPOSE. You are solely responsible for determining the | ||
| appropriateness of using or redistributing the Work and assume any | ||
| risks associated with Your exercise of permissions under this License. | ||
| 7. Disclaimer of Warranty. Unless required by applicable law or | ||
| agreed to in writing, Licensor provides the Work (and each | ||
| Contributor provides its Contributions) on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| implied, including, without limitation, any warranties or conditions | ||
| of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
| PARTICULAR PURPOSE. You are solely responsible for determining the | ||
| appropriateness of using or redistributing the Work and assume any | ||
| risks associated with Your exercise of permissions under this License. | ||
| 8. Limitation of Liability. In no event and under no legal theory, | ||
| whether in tort (including negligence), contract, or otherwise, | ||
| unless required by applicable law (such as deliberate and grossly | ||
| negligent acts) or agreed to in writing, shall any Contributor be | ||
| liable to You for damages, including any direct, indirect, special, | ||
| incidental, or consequential damages of any character arising as a | ||
| result of this License or out of the use or inability to use the | ||
| Work (including but not limited to damages for loss of goodwill, | ||
| work stoppage, computer failure or malfunction, or any and all | ||
| other commercial damages or losses), even if such Contributor | ||
| has been advised of the possibility of such damages. | ||
| 8. Limitation of Liability. In no event and under no legal theory, | ||
| whether in tort (including negligence), contract, or otherwise, | ||
| unless required by applicable law (such as deliberate and grossly | ||
| negligent acts) or agreed to in writing, shall any Contributor be | ||
| liable to You for damages, including any direct, indirect, special, | ||
| incidental, or consequential damages of any character arising as a | ||
| result of this License or out of the use or inability to use the | ||
| Work (including but not limited to damages for loss of goodwill, | ||
| work stoppage, computer failure or malfunction, or any and all | ||
| other commercial damages or losses), even if such Contributor | ||
| has been advised of the possibility of such damages. | ||
| 9. Accepting Warranty or Additional Liability. While redistributing | ||
| the Work or Derivative Works thereof, You may choose to offer, | ||
| and charge a fee for, acceptance of support, warranty, indemnity, | ||
| or other liability obligations and/or rights consistent with this | ||
| License. However, in accepting such obligations, You may act only | ||
| on Your own behalf and on Your sole responsibility, not on behalf | ||
| of any other Contributor, and only if You agree to indemnify, | ||
| defend, and hold each Contributor harmless for any liability | ||
| incurred by, or claims asserted against, such Contributor by reason | ||
| of your accepting any such warranty or additional liability. | ||
| 9. Accepting Warranty or Additional Liability. While redistributing | ||
| the Work or Derivative Works thereof, You may choose to offer, | ||
| and charge a fee for, acceptance of support, warranty, indemnity, | ||
| or other liability obligations and/or rights consistent with this | ||
| License. However, in accepting such obligations, You may act only | ||
| on Your own behalf and on Your sole responsibility, not on behalf | ||
| of any other Contributor, and only if You agree to indemnify, | ||
| defend, and hold each Contributor harmless for any liability | ||
| incurred by, or claims asserted against, such Contributor by reason | ||
| of your accepting any such warranty or additional liability. | ||
| END OF TERMS AND CONDITIONS | ||
| END OF TERMS AND CONDITIONS | ||
| APPENDIX: How to apply the Apache License to your work. | ||
| APPENDIX: How to apply the Apache License to your work. | ||
@@ -190,14 +190,14 @@ To apply the Apache License to your work, attach the following | ||
| Copyright [yyyy] [name of copyright owner] | ||
| Copyright [yyyy] [name of copyright owner] | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. |
+12
-10
| { | ||
| "name": "node-screenshots", | ||
| "version": "0.1.9", | ||
| "version": "0.2.0", | ||
| "main": "index.js", | ||
@@ -35,3 +35,5 @@ "types": "index.d.ts", | ||
| }, | ||
| "packageManager": "yarn@3.5.0", | ||
| "ava": { | ||
| "timeout": "3m" | ||
| }, | ||
| "devDependencies": { | ||
@@ -42,11 +44,11 @@ "@napi-rs/cli": "^2.16.3", | ||
| "optionalDependencies": { | ||
| "node-screenshots-win32-x64-msvc": "0.1.9", | ||
| "node-screenshots-darwin-x64": "0.1.9", | ||
| "node-screenshots-linux-x64-gnu": "0.1.9", | ||
| "node-screenshots-darwin-arm64": "0.1.9", | ||
| "node-screenshots-win32-arm64-msvc": "0.1.9", | ||
| "node-screenshots-linux-x64-musl": "0.1.9", | ||
| "node-screenshots-win32-ia32-msvc": "0.1.9", | ||
| "node-screenshots-darwin-universal": "0.1.9" | ||
| "node-screenshots-win32-x64-msvc": "0.2.0", | ||
| "node-screenshots-darwin-x64": "0.2.0", | ||
| "node-screenshots-linux-x64-gnu": "0.2.0", | ||
| "node-screenshots-darwin-arm64": "0.2.0", | ||
| "node-screenshots-win32-arm64-msvc": "0.2.0", | ||
| "node-screenshots-linux-x64-musl": "0.2.0", | ||
| "node-screenshots-win32-ia32-msvc": "0.2.0", | ||
| "node-screenshots-darwin-universal": "0.2.0" | ||
| } | ||
| } |
+82
-32
| # đ¸ node-screenshots | ||
| `node-screenshots` is a native node.js screenshot library that supports Mac, Windows, and Linux systems without any dependencies. | ||
| `node-screenshots` is a native node.js screenshot library based on [XCap](https://github.com/nashaofu/xcap), It supports Mac, Windows, and Linux systems without any dependencies. `node-screenshots` supports screenshot and video recording (to be implemented). | ||
@@ -11,3 +11,3 @@ English | [įŽäŊ䏿](README-zh_CN.md) | ||
| | Operating System | node14 | node16 | node18 | | ||
| | Operating System | node16 | node18 | node20 | | ||
| | ---------------- | ------ | ------ | ------ | | ||
@@ -24,47 +24,97 @@ | Windows x64 | â | â | â | | ||
| ### Monitor | ||
| ```ts | ||
| const fs = require("fs"); | ||
| const { Screenshots } = require("node-screenshots"); | ||
| const { Monitor } = require("node-screenshots"); | ||
| let capturer = Screenshots.fromPoint(100, 100); | ||
| let monitor = Monitor.fromPoint(100, 100); | ||
| console.log(capturer, capturer.id); | ||
| console.log(monitor, monitor.id); | ||
| // Synchronous capture | ||
| let image = capturer.captureSync(); | ||
| fs.writeFileSync("./a.png", image); | ||
| let image = monitor.captureImageSync(); | ||
| fs.writeFileSync(`${monitor.id}-sync.png`, image.toPngSync()); | ||
| // Asynchronous capture | ||
| capturer.capture().then((data) => { | ||
| console.log(data); | ||
| fs.writeFileSync(`${capturer.id}.png`, data); | ||
| monitor.captureImage().then((data) => { | ||
| console.log(data); | ||
| fs.writeFileSync(`${monitor.id}.jpeg`, data.toJpegSync()); | ||
| }); | ||
| // Get all screen captures | ||
| let all = Screenshots.all() ?? []; | ||
| let monitors = Monitor.all(); | ||
| all.forEach((capturer) => { | ||
| console.log({ | ||
| id: capturer.id, | ||
| x: capturer.x, | ||
| y: capturer.y, | ||
| width: capturer.width, | ||
| height: capturer.height, | ||
| rotation: capturer.rotation, | ||
| scaleFactor: capturer.scaleFactor, | ||
| isPrimary: capturer.isPrimary, | ||
| }); | ||
| capturer.captureSync(true); | ||
| monitors.forEach((capturer) => { | ||
| console.log({ | ||
| id: capturer.id, | ||
| x: capturer.x, | ||
| y: capturer.y, | ||
| width: capturer.width, | ||
| height: capturer.height, | ||
| rotation: capturer.rotation, | ||
| scaleFactor: capturer.scaleFactor, | ||
| isPrimary: capturer.isPrimary, | ||
| }); | ||
| }); | ||
| ``` | ||
| ### Window | ||
| ```ts | ||
| const fs = require("fs"); | ||
| const { Window } = require("node-screenshots"); | ||
| let windows = Window.all(); | ||
| windows.forEach((item) => { | ||
| console.log({ | ||
| id: item.id, | ||
| x: item.x, | ||
| y: item.y, | ||
| width: item.width, | ||
| height: item.height, | ||
| rotation: item.rotation, | ||
| scaleFactor: item.scaleFactor, | ||
| isPrimary: item.isPrimary, | ||
| }); | ||
| let image = item.captureImageSync(); | ||
| fs.writeFileSync(`${item.id}-sync.bmp`, image.toBmpSync()); | ||
| item.captureImage().then(async (data) => { | ||
| console.log(data); | ||
| let newImage = await data.crop(10, 10, 10, 10); | ||
| fs.writeFileSync(`${item.id}.png`, await newImage.toPng()); | ||
| }); | ||
| }); | ||
| ``` | ||
| ## API | ||
| - `Screenshots.fromPoint(x, y)`: Get a screenshot from the specified coordinates | ||
| - `Screenshots.all()`: Get all screenshots | ||
| - `screenshots.capture(copyOutputData)`: Asynchronously capture full screen | ||
| - `screenshots.captureSync(copyOutputData)`: Synchronously capture full screen | ||
| - `screenshots.captureArea(x, y, width, height, copyOutputData)`: Asynchronously capture the specified area | ||
| - `screenshots.captureAreaSync(x, y, width, height, copyOutputData)`: Synchronously capture the specified area | ||
| Full typeScript type definition: [index.d.ts](./index.d.ts) | ||
| ### Monitor | ||
| - `static all(): Array<Monitor>`: Get all monitor | ||
| - `static fromPoint(x: number, y: number): Monitor | null`: Get a monitor from the specified coordinates | ||
| - `captureImageSync(): Image`: Synchronously capture image | ||
| - `captureImage(): Promise<Image>`: Asynchronously capture image | ||
| ### Window | ||
| - `static all(): Array<Window>`: Get all window | ||
| - `captureImageSync(): Image`: Synchronously capture image | ||
| - `captureImage(): Promise<Image>`: Asynchronously capture image | ||
| ### Image | ||
| - `cropSync(x: number, y: number, width: number, height: number): Image`: Synchronously crop image | ||
| - `crop(x: number, y: number, width: number, height: number): Promise<Image>`: Asynchronously crop image | ||
| - `toPngSync(copyOutputData?: boolean | undefined | null): Buffer`:Synchronously Convert to png | ||
| - `toPng(copyOutputData?: boolean | undefined | null): Promise<Buffer>`: Asynchronously Convert to png | ||
| - `toJpegSync(copyOutputData?: boolean | undefined | null): Buffer`: Synchronously Convert to jpeg | ||
| - `toJpeg(copyOutputData?: boolean | undefined | null): Promise<Buffer>`: Asynchronously Convert to jpeg | ||
| - `toBmpSync(copyOutputData?: boolean | undefined | null): Buffer`: Synchronously Convert to bmp | ||
| - `toBmp(copyOutputData?: boolean | undefined | null): Promise<Buffer>`: Asynchronously Convert to bmp | ||
| - `toRawSync(copyOutputData?: boolean | undefined | null): Buffer`: Synchronously Convert to raw(RGBA data) | ||
| - `toRaw(copyOutputData?: boolean | undefined | null): Promise<Buffer>`: Asynchronously Convert to raw(RGBA data) | ||
| `copyOutputData`: pass related parameters in electron, otherwise electron will crash, nodejs does not pass or passes false, performance will be better, for more information refer to https://github.com/napi-rs/napi-rs/issues/1346 | ||
@@ -71,0 +121,0 @@ |
Shell access
Supply chain riskThis module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
Shell access
Supply chain riskThis module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
28562
21.34%376
40.82%135
58.82%