---
title: string/Base64Url.ts
nav_order: 24
parent: Modules
---

## Base64Url overview

Representing a URL-safe, Base64 encoded string.

For a non-URL-safe alternative, @see Base64

This module is heavily inspired by the `validator.js` module
[`isBase64`](https://github.com/validatorjs/validator.js/blob/master/src/lib/isBase64.js).

Added in v0.0.2

---

<h2 class="text-delta">Table of contents</h2>

- [Instances](#instances)
  - [Arbitrary](#arbitrary)
  - [Decoder](#decoder)
  - [Encoder](#encoder)
  - [Eq](#eq)
  - [Guard](#guard)
  - [TaskDecoder](#taskdecoder)
  - [Type](#type)
- [Model](#model)
  - [Base64Url (type alias)](#base64url-type-alias)
  - [SchemableParams (type alias)](#schemableparams-type-alias)
  - [SchemableParams1 (type alias)](#schemableparams1-type-alias)
  - [SchemableParams2 (type alias)](#schemableparams2-type-alias)
  - [SchemableParams2C (type alias)](#schemableparams2c-type-alias)
- [Refinements](#refinements)
  - [isBase64Url](#isbase64url)

---

# Instances

## Arbitrary

**Signature**

```ts
export declare const Arbitrary: Arb.Arbitrary<Base64Url>
```

Added in v0.0.3

## Decoder

**Signature**

```ts
export declare const Decoder: D.Decoder<unknown, Base64Url>
```

Added in v0.0.2

## Encoder

**Signature**

```ts
export declare const Encoder: Enc.Encoder<string, Base64Url>
```

Added in v0.0.3

## Eq

**Signature**

```ts
export declare const Eq: Eq_.Eq<Base64Url>
```

Added in v0.0.2

## Guard

**Signature**

```ts
export declare const Guard: G.Guard<unknown, Base64Url>
```

Added in v0.0.2

## TaskDecoder

**Signature**

```ts
export declare const TaskDecoder: TD.TaskDecoder<unknown, Base64Url>
```

Added in v0.0.2

## Type

**Signature**

```ts
export declare const Type: t.Type<Base64Url>
```

Added in v0.0.2

# Model

## Base64Url (type alias)

Representing a URL-safe, Base64 encoded string.

For a non-URL-safe alternative, @see Base64

Heavily inspired by the `validator.js` module
[`isBase64`](https://github.com/validatorjs/validator.js/blob/master/src/lib/isBase64.js).

**Signature**

```ts
export type Base64Url = string & Base64UrlBrand
```

Added in v0.0.2

## SchemableParams (type alias)

**Signature**

```ts
export type SchemableParams<S> = HKT2<S, string, Base64Url>
```

Added in v0.0.2

## SchemableParams1 (type alias)

**Signature**

```ts
export type SchemableParams1<S extends URIS> = Kind<S, Base64Url>
```

Added in v0.0.2

## SchemableParams2 (type alias)

**Signature**

```ts
export type SchemableParams2<S extends URIS2> = Kind2<S, string, Base64Url>
```

Added in v0.0.3

## SchemableParams2C (type alias)

**Signature**

```ts
export type SchemableParams2C<S extends URIS2> = Kind2<S, unknown, Base64Url>
```

Added in v0.0.2

# Refinements

## isBase64Url

**Signature**

```ts
export declare const isBase64Url: (s: string) => s is Base64Url
```

Added in v0.0.2