Skip to main content
Version: v3

ResourceType

The type of the resource - can be a string (for CRDs) or a constant from K8S

Example​

import { K8S } from '@shell/apis';

// Using constants (recommended)
resources.cluster.findAll(K8S.POD);

// Using strings (for CRDs or dynamic resources)
resources.cluster.findAll('mycompany.io.customresource');

Indexable​

[index: number]: string

Properties​

length​

readonly length: number;

Returns the length of a String object.

Methods​

[iterator]()​

iterator: StringIterator<string>;

Iterator

Returns​

StringIterator<string>

anchor()​

anchor(name): string;

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

Parameters​

name​

string

Returns​

string

Deprecated​

A legacy feature for browser compatibility

big()​

big(): string;

Returns a <big> HTML element

Returns​

string

Deprecated​

A legacy feature for browser compatibility

blink(): string;

Returns a <blink> HTML element

Returns​

string

Deprecated​

A legacy feature for browser compatibility

bold()​

bold(): string;

Returns a <b> HTML element

Returns​

string

Deprecated​

A legacy feature for browser compatibility

charAt()​

charAt(pos): string;

Returns the character at the specified index.

Parameters​

pos​

number

The zero-based index of the desired character.

Returns​

string

charCodeAt()​

charCodeAt(index): number;

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

Parameters​

index​

number

The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.

Returns​

number

codePointAt()​

codePointAt(pos): number;

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.

Parameters​

pos​

number

Returns​

number

concat()​

concat(...strings): string;

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

Parameters​

strings​

...string[]

The strings to append to the end of the string.

Returns​

string

endsWith()​

endsWith(searchString, endPosition?): 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.

Parameters​

searchString​

string

endPosition?​

number

Returns​

boolean

fixed()​

fixed(): string;

Returns a <tt> HTML element

Returns​

string

Deprecated​

A legacy feature for browser compatibility

fontcolor()​

fontcolor(color): string;

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

Parameters​

color​

string

Returns​

string

Deprecated​

A legacy feature for browser compatibility

fontsize()​

Call Signature​

fontsize(size): string;

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

Parameters​
size​

number

Returns​

string

Deprecated​

A legacy feature for browser compatibility

Call Signature​

fontsize(size): string;

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

Parameters​
size​

string

Returns​

string

Deprecated​

A legacy feature for browser compatibility

includes()​

includes(searchString, position?): 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.

Parameters​

searchString​

string

search string

position?​

number

If position is undefined, 0 is assumed, so as to search all of the String.

Returns​

boolean

indexOf()​

indexOf(searchString, position?): number;

Returns the position of the first occurrence of a substring.

Parameters​

searchString​

string

The substring to search for in the string

position?​

number

The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.

Returns​

number

italics()​

italics(): string;

Returns an <i> HTML element

Returns​

string

Deprecated​

A legacy feature for browser compatibility

lastIndexOf()​

lastIndexOf(searchString, position?): number;

Returns the last occurrence of a substring in the string.

Parameters​

searchString​

string

The substring to search for.

position?​

number

The index at which to begin searching. If omitted, the search begins at the end of the string.

Returns​

number

link(url): string;

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

Parameters​

url​

string

Returns​

string

Deprecated​

A legacy feature for browser compatibility

localeCompare()​

Call Signature​

localeCompare(that): number;

Determines whether two strings are equivalent in the current locale.

Parameters​
that​

string

String to compare to target string

Returns​

number

Call Signature​

localeCompare(
   that, 
   locales?, 
   options?): number;

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

Parameters​
that​

string

String to compare to target string

locales?​

string | string[]

A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.

options?​

CollatorOptions

An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

Returns​

number

match()​

Call Signature​

match(regexp): RegExpMatchArray;

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

Parameters​
regexp​

string | RegExp

A variable name or string literal containing the regular expression pattern and flags.

Returns​

RegExpMatchArray

Call Signature​

match(matcher): RegExpMatchArray;

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.

Parameters​
matcher​

An object that supports being matched against.

[match]​
Returns​

RegExpMatchArray

normalize()​

Call Signature​

normalize(form): 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.

Parameters​
form​

"NFC" | "NFD" | "NFKC" | "NFKD"

Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns​

string

Call Signature​

normalize(form?): 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.

Parameters​
form?​

string

Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns​

string

repeat()​

repeat(count): string;

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

Parameters​

count​

number

number of copies to append

Returns​

string

replace()​

Call Signature​

replace(searchValue, replaceValue): string;

Replaces text in a string, using a regular expression or search string.

Parameters​
searchValue​

string | RegExp

A string or regular expression to search for.

replaceValue​

string

A string containing the text to replace. When the searchValue is a RegExp, all matches are replaced if the g flag is set (or only those matches at the beginning, if the y flag is also present). Otherwise, only the first match of searchValue is replaced.

Returns​

string

Call Signature​

replace(searchValue, replacer): string;

Replaces text in a string, using a regular expression or search string.

Parameters​
searchValue​

string | RegExp

A string to search for.

replacer​

(substring, ...args) => string

A function that returns the replacement text.

Returns​

string

Call Signature​

replace(searchValue, replaceValue): string;

Passes a string and replaceValue to the [Symbol.replace] method on searchValue. This method is expected to implement its own replacement algorithm.

Parameters​
searchValue​

An object that supports searching for and replacing matches within a string.

[replace]​
replaceValue​

string

The replacement text.

Returns​

string

Call Signature​

replace(searchValue, replacer): string;

Replaces text in a string, using an object that supports replacement within a string.

Parameters​
searchValue​

A object can search for and replace matches within a string.

[replace]​
replacer​

(substring, ...args) => string

A function that returns the replacement text.

Returns​

string

Call Signature​

search(regexp): number;

Finds the first substring match in a regular expression search.

Parameters​
regexp​

string | RegExp

The regular expression pattern and applicable flags.

Returns​

number

Call Signature​

search(searcher): number;

Finds the first substring match in a regular expression search.

Parameters​
searcher​

An object which supports searching within a string.

[search]​
Returns​

number

slice()​

slice(start?, end?): string;

Returns a section of a string.

Parameters​

start?​

number

The index to the beginning of the specified portion of stringObj.

end?​

number

The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.

Returns​

string

small()​

small(): string;

Returns a <small> HTML element

Returns​

string

Deprecated​

A legacy feature for browser compatibility

split()​

Call Signature​

split(separator, limit?): string[];

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

Parameters​
separator​

string | RegExp

A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.

limit?​

number

A value used to limit the number of elements returned in the array.

Returns​

string[]

Call Signature​

split(splitter, limit?): string[];

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

Parameters​
splitter​

An object that can split a string.

[split]​
limit?​

number

A value used to limit the number of elements returned in the array.

Returns​

string[]

startsWith()​

startsWith(searchString, position?): 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.

Parameters​

searchString​

string

position?​

number

Returns​

boolean

strike()​

strike(): string;

Returns a <strike> HTML element

Returns​

string

Deprecated​

A legacy feature for browser compatibility

sub()​

sub(): string;

Returns a <sub> HTML element

Returns​

string

Deprecated​

A legacy feature for browser compatibility

substr()​

substr(from, length?): string;

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

Parameters​

from​

number

The starting position of the desired substring. The index of the first character in the string is zero.

length?​

number

The number of characters to include in the returned substring.

Returns​

string

Deprecated​

A legacy feature for browser compatibility

substring()​

substring(start, end?): string;

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

Parameters​

start​

number

The zero-based index number indicating the beginning of the substring.

end?​

number

Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.

Returns​

string

sup()​

sup(): string;

Returns a <sup> HTML element

Returns​

string

Deprecated​

A legacy feature for browser compatibility

toLocaleLowerCase()​

toLocaleLowerCase(locales?): string;

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

Parameters​

locales?​

string | string[]

Returns​

string

toLocaleUpperCase()​

toLocaleUpperCase(locales?): string;

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

Parameters​

locales?​

string | string[]

Returns​

string

toLowerCase()​

toLowerCase(): string;

Converts all the alphabetic characters in a string to lowercase.

Returns​

string

toString()​

toString(): string;

Returns a string representation of a string.

Returns​

string

toUpperCase()​

toUpperCase(): string;

Converts all the alphabetic characters in a string to uppercase.

Returns​

string

trim()​

trim(): string;

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

Returns​

string

valueOf()​

valueOf(): string;

Returns the primitive value of the specified object.

Returns​

string