SERIALIZE_TO_IPC_FN

Module @netwiv/api/core · Kind Constant

import { SERIALIZE_TO_IPC_FN } from '@netwiv/api/core';

A key to be used to implement a special function on your types that define how your type should be serialized when passing across the IPC.

Members

anchor

anchor(name: string): string

Returns an <a> HTML anchor element and sets the name attribute to the text value

Deprecated A legacy feature for browser compatibility

at

at(index: number): string | undefined

Returns a new String consisting of the single UTF-16 code unit located at the specified index.

big

big(): string

Returns a <big> HTML element

Deprecated A legacy feature for browser compatibility

blink

blink(): string

Returns a <blink> HTML element

Deprecated A legacy feature for browser compatibility

bold

bold(): string

Returns a <b> HTML element

Deprecated A legacy feature for browser compatibility

charAt

charAt(pos: number): string

Returns the character at the specified index.

charCodeAt

charCodeAt(index: number): number

Returns the Unicode value of the character at the specified location.

codePointAt

codePointAt(pos: number): number | undefined

Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.

concat

concat(...strings: string[]): string

Returns a string that contains the concatenation of two or more strings.

endsWith

endsWith(searchString: string, endPosition?: number | undefined): boolean

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false.

fixed

fixed(): string

Returns a <tt> HTML element

Deprecated A legacy feature for browser compatibility

fontcolor

fontcolor(color: string): string

Returns a <font> HTML element and sets the color attribute value

Deprecated A legacy feature for browser compatibility

fontsize

fontsize(size: number): string
fontsize(size: string): string

Returns a <font> HTML element and sets the size attribute value

Deprecated A legacy feature for browser compatibility

includes

includes(searchString: string, position?: number | undefined): boolean

Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false.

indexOf

indexOf(searchString: string, position?: number | undefined): number

Returns the position of the first occurrence of a substring.

italics

italics(): string

Returns an <i> HTML element

Deprecated A legacy feature for browser compatibility

lastIndexOf

lastIndexOf(searchString: string, position?: number | undefined): number

Returns the last occurrence of a substring in the string.

length

readonly length: number

Returns the length of a String object.

link

link(url: string): string

Returns an <a> HTML element and sets the href attribute value

Deprecated A legacy feature for browser compatibility

localeCompare

localeCompare(that: string): number
localeCompare(that: string, locales?: string | string[] | undefined, options?: CollatorOptions | undefined): number
localeCompare(that: string, locales?: LocalesArgument, options?: CollatorOptions | undefined): number

Determines whether two strings are equivalent in the current locale. Determines whether two strings are equivalent in the current or specified locale.

match

match(regexp: string | RegExp): RegExpMatchArray | null
match(matcher: { [Symbol.match](string: string): RegExpMatchArray | null; }): RegExpMatchArray | null

Matches a string with a regular expression, and returns an array containing the results of that search. Matches a string or an object that supports being matched against, and returns an array containing the results of that search, or null if no matches are found.

matchAll

matchAll(regexp: RegExp): RegExpStringIterator<RegExpExecArray>

Matches a string with a regular expression, and returns an iterable of matches containing the results of that search.

normalize

normalize(form: "NFC" | "NFD" | "NFKC" | "NFKD"): string
normalize(form?: string | undefined): string

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

padEnd

padEnd(maxLength: number, fillString?: string | undefined): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string.

padStart

padStart(maxLength: number, fillString?: string | undefined): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string.

repeat

repeat(count: number): string

Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned.

replace

replace(searchValue: string | RegExp, replaceValue: string): string
replace(searchValue: string | RegExp, replacer: (substring: string, ...args: any[]): string) => string
replace(searchValue: { [Symbol.replace](string: string, replaceValue: string): string; }, replaceValue: string): string
replace(searchValue: { [Symbol.replace](string: string, replacer: (substring: string, ...args: any[]): string): string; }, replacer: (substring: string, ...args: any[]) => string) => string

Replaces text in a string, using a regular expression or search string. Passes a string and {@linkcode replaceValue} to the [Symbol.replace] method on {@linkcode searchValue}. This method is expected to implement its own replacement algorithm. Replaces text in a string, using an object that supports replacement within a string.

replaceAll

replaceAll(searchValue: string | RegExp, replaceValue: string): string
replaceAll(searchValue: string | RegExp, replacer: (substring: string, ...args: any[]): string) => string

Replace all instances of a substring in a string, using a regular expression or search string.

search

search(regexp: string | RegExp): number
search(searcher: { [Symbol.search](string: string): number; }): number

Finds the first substring match in a regular expression search.

slice

slice(start?: number | undefined, end?: number | undefined): string

Returns a section of a string.

small

small(): string

Returns a <small> HTML element

Deprecated A legacy feature for browser compatibility

split

split(separator: string | RegExp, limit?: number | undefined): string[]
split(splitter: { [Symbol.split](string: string, limit?: number | undefined): string[]; }, limit?: number | undefined): string[]

Split a string into substrings using the specified separator and return them as an array.

startsWith

startsWith(searchString: string, position?: number | undefined): boolean

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false.

strike

strike(): string

Returns a <strike> HTML element

Deprecated A legacy feature for browser compatibility

sub

sub(): string

Returns a <sub> HTML element

Deprecated A legacy feature for browser compatibility

substr

substr(from: number, length?: number | undefined): string

Gets a substring beginning at the specified location and having the specified length.

Deprecated A legacy feature for browser compatibility

substring

substring(start: number, end?: number | undefined): string

Returns the substring at the specified location within a String object.

sup

sup(): string

Returns a <sup> HTML element

Deprecated A legacy feature for browser compatibility

toLocaleLowerCase

toLocaleLowerCase(locales?: string | string[] | undefined): string
toLocaleLowerCase(locales?: LocalesArgument): string

Converts all alphabetic characters to lowercase, taking into account the host environment’s current locale.

toLocaleUpperCase

toLocaleUpperCase(locales?: string | string[] | undefined): string
toLocaleUpperCase(locales?: LocalesArgument): string

Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment’s current locale.

toLowerCase

toLowerCase(): string

Converts all the alphabetic characters in a string to lowercase.

toString

toString(): string

Returns a string representation of a string.

toUpperCase

toUpperCase(): string

Converts all the alphabetic characters in a string to uppercase.

trim

trim(): string

Removes the leading and trailing white space and line terminator characters from a string.

trimEnd

trimEnd(): string

Removes the trailing white space and line terminator characters from a string.

trimLeft

trimLeft(): string

Removes the leading white space and line terminator characters from a string.

Deprecated A legacy feature for browser compatibility. Use trimStart instead

trimRight

trimRight(): string

Removes the trailing white space and line terminator characters from a string.

Deprecated A legacy feature for browser compatibility. Use trimEnd instead

trimStart

trimStart(): string

Removes the leading white space and line terminator characters from a string.

valueOf

valueOf(): string

Returns the primitive value of the specified object.

Example

Given a type in Rust that looks like this

#[derive(serde::Serialize, serde::Deserialize)
enum UserId {
  String(String),
  Number(u32),
}

UserId::String("id") would be serialized into { String: "id" } and so we need to pass the same structure back to Rust

import { SERIALIZE_TO_IPC_FN } from "@netwiv/api/core"

class UserIdString {
  id
  constructor(id) {
    this.id = id
  }

  [SERIALIZE_TO_IPC_FN]() {
    return { String: this.id }
  }
}

class UserIdNumber {
  id
  constructor(id) {
    this.id = id
  }

  [SERIALIZE_TO_IPC_FN]() {
    return { Number: this.id }
  }
}

type UserId = UserIdString | UserIdNumber

---

Descriptions come from the pinned @tauri-apps/api@2.11.1 declarations (MIT OR Apache-2.0); imports are shown with @netwiv/api paths.