JSPM

safe-images

1.0.20
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q21654F
  • License ISC

Safe Image Package To Check Images Safty

Package Exports

  • safe-images
  • safe-images/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (safe-images) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Safe-Images - NSFW Detection Package

NPM version NPM downloads


A Node.js package for detecting NSFW (Not Safe For Work) content in images using the SmartClick AI NSFW Detection API.

Installation

Install the package using npm:

npm install safe-Images

Usage

Import Package:

const SafeImage = require('safe-Images');
const safeImage = new SafeImage();

Usage with URL:

const imageURL = 'https://example.com/path/to/image.jpg';

safeImage.detectFromURL(imageURL)
  .then((result) => {
    console.log('Not Safe:', result);
  })
  .catch((error) => {
    console.error('Error:', error.message);
  });

Usage with image file (Buffer):

const fs = require('fs');
const imageFilePath = 'path/to/your/image.jpg';
const imageBuffer = fs.readFileSync(imageFilePath);

safeImage.detectFromFile(imageBuffer)
  .then((result) => {
    console.log('Not Safe:', result);
  })
  .catch((error) => {
    console.error('Error:', error.message);
  });

Use custom API key:

const safeImage = new SafeImage("YOUR_CUSTOM_API_KEY");
  • You can get API key from Here
  • If you don't provide a custom API key, the package will use the default API key provided by SmartClick AI.

API Key

To use the NSFW detection service, you need to obtain an API key from SmartClick AI . You can either pass your custom API key when creating an instance of the SafeImage class or leave it empty to use the default API key.

License

This package is open-source and available under the LICENSE .

Note

This package relies on an external NSFW detection service provided by SmartClick AI. Make sure you comply with their terms of service and usage policy.

Issues

If you encounter any issues or have suggestions for improvements, please open an issue on GitHub.