WebStack Screenshot

Sprache: Englisch 中文

Webstack-Creenshot

Website Screenshot API

Einführung

Nur ein paar einfache Screenshot -Operationen, wenn Sie Anforderungen haben oder an der Entwicklung teilnehmen möchten, begrüßen wir Sie bei PR

Schneller Start

Vercel Free Bereitstellung

Installation

npm install webstack-screenshot --save

 const webstackScreenshot = require ( 'webstack-screenshot' )

webstackScreenshot ( { url : 'https://example.com' } ) . then ( ( buffer ) => {
  console . log ( 'buffer' , buffer )
} )

webstackScreenshot ( { url : 'https://example.com' , encoding : 'base64' } ) . then ( ( base64 ) => {
  console . log ( 'base64' , base64 )
} )

Serverlos

Sie müssen einen Umgebungsvariablennamen WEBSTACK_SCREENSHOT_SERVERLESS konfigurieren, und der Wert der Umgebungsvariablen kann jeder gewünschte Wert sein, z. B. true .

Möglicherweise müssen Sie Schriftdateien manuell konfigurieren, wenn die abgefangene Site Text in anderen Sprachen enthält.

Konfigurieren Sie den Umgebungsvariablennamen WEBSTACK_SCREENSHOT_FONTS , der Umgebungsvariablenwert kann eine URL oder ein Pfad sein. Mehrere Schriftartdateien müssen aufgeteilt werden , Die URL -Adresse muss https:// sein, Pfad muss ein absoluter Pfad sein.

eg /var/task/fonts/xxx.ttf,https://xxxxx/xxx/xxx.ttf .

 module . exports = require ( 'webstack-screenshot/dist/src/serverless' )

Klonlager

Clone Remote Repository Start Website Screenshot API

 # Clone the repository and go to the WebStack-Screenshot directory
git clone https://github.com/Lete114/WebStack-Screenshot.git WebStack-Screenshot
cd WebStack-Screenshot

# Installing Dependencies
npm install

# Start service
npm run start

Eigenschaften

Anforderungsmethode: Get | POST

Eigenschaften	Standard	Typ	Beschreibung
URL		Saite	Die URL der angeforderten Website, wenn der Domänenname eingegeben wird, wird er automatisch als http:// geschrieben
Typ	JPEG	Saite	Der Bildtyp, png , jpeg , webp
Cache	86400	Int & boolean	Cache, Standard -Cache ist 1 Tag, passieren false um den Cache zu deaktivieren, übergebene Nummer wie: 123 bis 123 Sekunden Cache
Qualität	50	Int	Bildqualität zwischen 0-100 , ignoriert, wenn der Bildtyp png ist
Ansichtsfenster	{width: 1080,height: 1920,isMobile: false}	String | Ansichtsfenster	Stellen Sie die Bildschirmfenstergröße ein
FullPage	FALSCH	Boolean	Erfassen Sie die vollständige Seite
Ismobil	FALSCH	Boolean	Wenn es mobil ist oder nicht
erwarten	1000	Int	Warten Sie, bis die Seite das Rendering beendet hat
Time-out	30000	Int	Screenshot Timeout, 0 bedeutet keine Grenze (in Millisekunden)
Codierung	binär	Saite	Bildcodierung, binary , base64
Clip		Saite	Clip den angegebenen Bereich, erhalten Sie 4 Einheiten geteilt durch englisches Komma , x,y,width,height
warte	laden	Saite	Zu welchem ​​Zeitpunkt des Screenshot ausgelöst wird, finden Sie eine weitere Tabelle unten für Details

warte

Eigenschaften	Beschreibung
laden	Gemacht, wenn das Lastereignis abgefeuert wird
Domcontent geladen	Gemacht, wenn das Domcontent -Ereignis abgefeuert wird.
NetworkIdle0	Wenn es keine Website -Anfragen innerhalb von 500 ms gibt
NetworkIdle2	Wenn es nur 2 Anfragen innerhalb von 500 ms gibt