@types/urlsafe-base64
TypeScript icon, indicating that this package has built-in type declarations

1.0.31 • Public • Published

Installation

npm install --save @types/urlsafe-base64

Summary

This package contains type definitions for urlsafe-base64 (https://github.com/RGBboy/urlsafe-base64).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/urlsafe-base64.

index.d.ts

/// <reference types="node"/>

/**
 * Library version.
 */
export declare var version: string;

/**
 * .encode
 *
 * return an encoded Buffer as URL Safe Base64
 *
 * Note: This function encodes to the RFC 4648 Spec where '+' is encoded
 *       as '-' and '/' is encoded as '_'. The padding character '=' is
 *       removed.
 *
 * @param {Buffer} buffer
 * @return {String}
 * @api public
 */
export declare function encode(buffer: Buffer): string;

/**
 * .decode
 *
 * return an decoded URL Safe Base64 as Buffer
 *
 * @param {String}
 * @return {Buffer}
 * @api public
 */
export declare function decode(base64: string): Buffer;

/**
 * .validate
 *
 * Validates a string if it is URL Safe Base64 encoded.
 *
 * @param {String}
 * @return {Boolean}
 * @api public
 */
export declare function validate(base64: string): boolean;

Additional Details

  • Last updated: Tue, 07 Nov 2023 15:11:36 GMT
  • Dependencies: @types/node

Credits

These definitions were written by Tanguy Krotoff.

Dependents (1)

Package Sidebar

Install

npm i @types/urlsafe-base64

Weekly Downloads

12,634

Version

1.0.31

License

MIT

Unpacked Size

4.33 kB

Total Files

5

Last publish

Collaborators

  • types