Home Reference Source
import Encoding from '~/models/Encoding.js'
public class | source

Encoding

Represents an encoding

Static Method Summary

Static Public Methods
public static

async all(): Promise<Set<Encoding>>

Obtains list of encodings through query

public static

Gets from an encoding name

public static

Obtains query

Constructor Summary

Public Constructor
public

Encoding name.

Member Summary

Public Members
public get
public

The actual name of the encoding suitable for delivering to backend

Method Summary

Public Methods
public

byteCount(string: string): number

Byte-length of a JS string in this encoding

Static Public Methods

public static async all(): Promise<Set<Encoding>> source

Obtains list of encodings through query

Return:

Promise<Set<Encoding>>

public static fromName(name: string): Encoding source

Gets from an encoding name

Params:

NameTypeAttributeDescription
name string

Return:

Encoding

public static async query(): Promise<Query<Encoding>> source

Obtains query

Return:

Promise<Query<Encoding>>

Public Constructors

public constructor(name: string) source

Encoding name. If not a valid encoding undefined behavior. Recommended to use fromName static

Params:

NameTypeAttributeDescription
name string

associated name

Public Members

public get displayName: string source

public name: string source

The actual name of the encoding suitable for delivering to backend

Public Methods

public byteCount(string: string): number source

Byte-length of a JS string in this encoding

Params:

NameTypeAttributeDescription
string string

Return:

number

postive integer