Skip to content

Commit

Permalink
chore: updating doc adding new validate function isValidImage
Browse files Browse the repository at this point in the history
  • Loading branch information
@gabriel-logan
gabriel-logan committed Mar 17, 2024
1 parent b473595 commit f984291
Show file tree
Hide file tree
Showing 3 changed files with 200 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/subPages/documentation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,9 @@
<li>
<a href="../functions/validateTextarea">validateTextarea</a>
</li>
<li>
<a href="../functions/isValidImage">isValidImage</a>
</li>
</ul>
</div>
<!-- /#sidebar-wrapper -->
Expand Down Expand Up @@ -217,6 +220,7 @@ <h3>Available Validation Modules</h3>
<li><strong>validateName:</strong> Name validation.</li>
<li><strong>validateSurname:</strong> Surname validation.</li>
<li><strong>validateTextarea:</strong> Textarea validation.</li>
<li><strong>isValidImage:</strong> Checks whether the image is valid by analyzing the bytes of the file.</li>
</ul>

<p>if you prefer, you can use importing as:</p>
Expand Down
195 changes: 195 additions & 0 deletions docs/subPages/functions/isValidImage.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,195 @@
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Page with documentation explaining how to use function methods">
<title>isValidImage</title>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.1.3/css/bootstrap.min.css">
<link rel="stylesheet" href="../../css/documentation/style.css">
<link rel="stylesheet" href="../../css/functions/style.css"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.24.1/themes/prism.min.css" />


</head>

<body>
<section>

<div id="wrapper" class="toggled">

<!-- Sidebar -->
<div id="sidebar-wrapper">
<ul class="sidebar-nav">
<li class="sidebar-brand">
<a href="../documentation/">
Documentation
</a>
</li>
<li>
<a href="https://gabriel-logan.github.io/multiform-validator/">Home</a>
</li>
<li>
<a href="../functions/cpfIsValid">cpfIsValid</a>
</li>
<li>
<a href="../functions/cnpjIsValid">cnpjIsValid</a>
</li>
<li>
<a href="../functions/isEmail">isEmail</a>
</li>
<li>
<a href="../functions/validateEmail">validateEmail</a>
</li>
<li>
<a href="../functions/isCEP">isCEP</a>
</li>
<li>
<a href="../functions/validateUsername">validateUsername</a>
</li>
<li>
<a href="../functions/validatePassword">validatePassword</a>
</li>
<li>
<a href="../functions/getOnlyEmail">getOnlyEmail</a>
</li>
<li>
<a href="../functions/isCreditCardValid">isCreditCardValid</a>
</li>
<li>
<a href="../functions/identifyFlagCard">identifyFlagCard</a>
</li>
<li>
<a href="../functions/isMACAddress">isMACAddress</a>
</li>
<li>
<a href="../functions/isAscii">isAscii</a>
</li>
<li>
<a href="../functions/isBase64">isBase64</a>
</li>
<li>
<a href="../functions/isDate">isDate</a>
</li>
<li>
<a href="../functions/isDecimal">isDecimal</a>
</li>
<li>
<a href="../functions/isEmpty">isEmpty</a>
</li>
<li>
<a href="../functions/isMD5">isMD5</a>
</li>
<li>
<a href="../functions/isPort">isPort</a>
</li>
<li>
<a href="../functions/isPostalCode">isPostalCode</a>
</li>
<li>
<a href="../functions/isTime">isTime</a>
</li>
<li>
<a href="../functions/validatePassportNumber">validatePassportNumber</a>
</li>
<li>
<a href="../functions/validateBRPhoneNumber">validateBRPhoneNumber</a>
</li>
<li>
<a href="../functions/validateUSPhoneNumber">validateUSPhoneNumber</a>
</li>
<li>
<a href="../functions/validatePhoneNumber">validatePhoneNumber</a>
</li>
<li>
<a href="../functions/isNumber">isNumber</a>
</li>
<li>
<a href="../functions/passwordStrengthTester">passwordStrengthTester</a>
</li>
<li>
<a href="../functions/validateName">validateName</a>
</li>
<li>
<a href="../functions/validateSurname">validateSurname</a>
</li>
<li>
<a href="../functions/validateTextarea">validateTextarea</a>
</li>
<li>
<a href="../functions/isValidImage">isValidImage</a>
</li>

</ul>
</div>
<!-- /#sidebar-wrapper -->

<!-- Page Content -->
<div id="page-content-wrapper">
<div class="container-fluid">
<h1>How to use the isValidImage function</h1>
<p>The <code>isValidImage</code> function is used to check whether an image file is valid or not. It accepts a file path as an argument.</p>
<pre>
<code class="language-javascript">
import { isValidImage } from 'multiform-validator

const imagePath = './path/to/your/image.jpg';
const isValid = isValidImage(imagePath);

console.log(isValid); // true if the image is valid, false otherwise
</code>
</pre>

<h2 style="margin-top: 35px;">Example Usage with Express and Multer</h2>
<pre>
<code class="language-javascript">
const express = require('express');
const multer = require('multer');
const upload = multer({ dest: 'uploads/' });
const { isValidImage } = require('multiform-validator');

const app = express();

app.post('/upload', upload.single('image'), (req, res) => {
const file = req.file;
const isValid = isValidImage(file.path);

if (isValid) {
res.send('The image is valid.');
} else {
res.send('The image is not valid.');
}
});

app.listen(3000, () => console.log('Server started on port 3000'));
</code>
</pre>
<p>First, import the <code>isValidImage</code> function from 'multiform-validator'. Then, define the path to the image you want to check. Call the <code>isValidImage</code> function with the image path as an argument. The function will return <code>true</code> if the image is valid and <code>false</code> if it is not.</p>
</div>
</div>
<!-- /#page-content-wrapper -->

</div>
<!-- /#wrapper -->

<!-- Menu Toggle Script -->
<script>
$("#menu-toggle").click(function(e) {
e.preventDefault();
$("#wrapper").toggleClass("toggled");
});
</script>


</section>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.24.1/prism.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.24.1/components/prism-javascript.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.24.1/components/prism-css.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.24.1/components/prism-scss.min.js"></script>
<script src="../../js/functions/index.js"></script>
<!-- partial -->
<script src='https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js'></script>
</body>

</html>
1 change: 1 addition & 0 deletions packages/typescript/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ This package contains various modules for validating different types of data. Be
- **validateName**: Name validation.
- **validateSurname**: Surname validation.
- **validateTextarea**: Textarea validation.
- **isValidImage**: Checks whether the image is valid by analyzing the bytes of the file.

### You can use it in React Native, Angular, any javascript framework or any javascript or typescript code.
#### Example using Reactjs:
Expand Down

0 comments on commit f984291

Please sign in to comment.