miguelmota / is-base64 Goto Github PK

View Code? Open in Web Editor NEW

30.0 3.0 4.0 20 KB

Predicate that returns true if base64 string.

Home Page: https://github.com/miguelmota/is-base64

License: MIT License

JavaScript 100.00%

base64 nodejs javascript predicate utility validation

is-base64's Introduction

is-base64

Predicate that returns true if base64 string.

Install

npm install is-base64

Usage

var isBase64 = require('is-base64');

var string = 'iVBORw0KGgoAAAAN ... kSuQmCC';
var stringWithMime = 'data:image/png;base64,iVBORw0KGgoAAAA ... AAElFTkSuQmCC';

console.log(isBase64(string)); // true
console.log(isBase64(stringWithMime)); // false
console.log(isBase64(stringWithMime, {allowMime: true})); // true
console.log(isBase64(string, {mimeRequired: true})); // false
console.log(isBase64(stringWithMime, {mimeRequired: true})); // true
console.log(isBase64('1342234')); // false
console.log(isBase64('afQ$%rfew')); // false
console.log(isBase64('dfasdfr342')); // false
console.log(isBase64('uuLMhh==')); // true
console.log(isBase64('uuLMhh')); // false
console.log(isBase64('uuLMhh', {paddingRequired: false})); // true
console.log(isBase64('')); // true
console.log(isBase64('', {allowEmpty: false})); // false

API

isBase64(string, options)

{string} string - string to check if is valid base64 string
{object} [options]
- [options.allowEmpty=true] {boolean} - returns true for empty string
- [options.allowMime=false] {boolean} - returns true for valid strings with optional mime
- [options.mimeRequired=false] {boolean} - returns true for valid strings with mime
- [options.paddingRequired=true] {boolean} - returns true for valid strings with valid padding

CLI

Install CLI:

npm install -g is-base64

CLI example:

$ is-base64 aGVsbG8gd29ybGQ=
true

Piping example:

$ echo aGVsbG8gd29ybGQ= | is-base64
true

FAQ

Q: Why is empty string "" a valid base64 string by default?
- A: According to RFC 4648 Section 10, the following is valid test vector:
```
BASE64("") = ""
```

License

MIT

is-base64's People

Contributors

Stargazers

Watchers

Forkers

royalone94 workaja hevtiq amirking59

is-base64's Issues

BUG: only supports png base64 strings

Current isBase64 regex only detects png files.

Edit: Made a pull request #2 that adds detection for any mimetype

True is returned for empty string as well as 'high'

const isbase64 = require('is-base64')

const text1 = ''
console.log(isbase64(text1, { mime: true }))
// true

const text2 = 'high'
console.log(isbase64(text2, { mime: true }))
// true```

Option to detect if string is base64 without mime

Hi @miguelmota!

Sometimes there are cases when we can easily handle datauri strings

var img = new Image(); img.src = dataUriString

but we cannot that easily handle raw base64 string, we have to convert them to datauri via create-data-uri or alike.

That would be nice to have an option to detect only base64 string without mime type:

isBase64('data:image/png;base64,iVBORw0KGgoAAAA ... AAElFTkSuQmCC') // true
isBase64('data:image/png;base64,iVBORw0KGgoAAAA ... AAElFTkSuQmCC', {mime: false}) // false

Doesn't work on string "test"

I've noticed that testing the string "test" will report true:

isBase64('test');
// => true

The same is true for other combinations of the same letters, such as "estt", "sett" etc.

Bug with DELL word

When i test if DELL word is a base64 string, your function returns true...

True is returned when passing true as argument

When passing true as argument, true is returned.

> require('is-base64')(true)
true

This is unexpected for me because true is not base64 so I would expect false.

isBase64('admin111') === true

How to Filter Mime Only Jpg and Png ?

How to filter allowMime only jpg and png datatypes?

Any string of 4 characters, consisting of letters and numbers, can pass the check.

console.log(isBase64('X209')); // true console.log(isBase64('1234')); // true console.log(isBase64('AABB')); // true console.log(isBase64('AV12')); // true console.log(isBase64('123A')); // true

RangeError: Maximum call stack size exceeded for big string (over 5MB)

Hello,
Using your library in webdriverio project and we have an error "RangeError: Maximum call stack size exceeded" when we call isBase64 function with big string

Thankyou for your help

bigString.txt

Corner case

Hi @miguelmota!
Just stumbled upon

isBase64('uuLMhh') //false

Although that ↑ should be true