API [Polish] - KrzysztofZawisla/WasmQuery GitHub Wiki

API

Spis treści

Rejestracji biblioteki

Aby zaimplementować rozwiązania z biblioteki musisz ją najpierw zarejestrować. Bez tego nie będziesz miał dostępu do funkcji w niej zawartych. Jest to forma inicjalizacji biblioteki.

Sygnatura funkcji:

registerWasmQuery(): void;
registerWasmQuery(selector: string): void;
registerWasmQuery(selectors: string[]): void;

Przykład wykorzystania:

registerWasmQuery(); // rejestruje bibliotekę pod znakiem $
registerWasmQuery("wasmQuery"); // rejestruje bibliotekę pod podaną przez programistę nazwę
registerWasmQuery(["$", "wasmQuery", "test"]); // rejestruje bibliotekę pod wiele nazw podanych przez programistę

Odpowiednik w GO jest dostępny w pakiecie core i pliku wasmQueryRegisterLibrary.go pod funkcją o nazwie WasmQueryRegisterLibrary

Moduł ShortQuery

Dostęp do modułu uzyskamy poprzez:

$: Function;

Moduł ten w dość mocnym stopniu wzoruje się na jQuery. Zasada działania jest podobna do wspomnianego już jQuery lecz nie identyczna. Pozwoliliśmy sobie rozbudować ideę „Write Less, Do More” poprzez zmianę sposobu działania konstruktora. W ShortQuery konstruktor zwraca tablice elementów wraz ze swoimi funkcjami oraz dodaje dla każdego elementu z tablicy funkcję która jest odpowiednikiem wykonywanym na całym zbiorze czyli tablicy. W skrócie dzięki temu rozwiązaniu możemy wywoływać funkcje dla poszczególnych elementów w ten sposób:

$("selektor")[indeks].funkcja();

Dodatkowo zastąpiliśmy model łańcuchowych wykonań funkcji na operacje tablicowe co jeszcze bardziej pozwoliło skrócić ilość kodu. Dla przykładu nadanie trzem elementom o klasie test atrybutu alt oraz src nie wygląda tak:

$(".test").attr("alt", "Nosacz Sundajski").attr("src", "https://upload.wikimedia.org/wikipedia/commons/thumb/8/82/Proboscis_Monkey.jpg/240px-Proboscis_Monkey.jpg");

tylko tak:

$(".test").attr(["alt", "src"], ["Nosacz Sundajski", "https://upload.wikimedia.org/wikipedia/commons/thumb/8/82/Proboscis_Monkey.jpg/240px-Proboscis_Monkey.jpg"]);

Ogólna składnia

$("selektor").funkcja();

Kilka przykładowych wywołań funkcji na zbiorze DOM elementów:

$(".test").css("color", "red");
$("#test").attr("src", "https://www.youtube.com/watch?v=dQw4w9WgXcQ");
$("input").val("taco, burrito, etc.");
$("a").href("https://www.youtube.com/watch?v=PGNiXGX2nLU");

Jeśli chcemy wywołać tylko na jednym DOM elemencie daną funkcję możemy podać indeks tablicy np.:

$(".test")[0].css("color", "fuchsia");
$("#test")[1].toggleClass("alert");
$("input")[2].css("border-radius", "15px");
$("h2")[3].hide();

Moduł Time

Dostęp do modułu uzyskamy poprzez:

$.time: Object;

Moduł ten pozwala na uzyskania szczegółowych informacji o czasie/dacie oraz na manipulacje nim/nią.

Funkcja now

Funkcja ta zwraca pełną aktualną datę według formatu w GO.

Sygnatura funkcji:

$.time.now(): string;

Funkcja year

Funkcja ta zwraca aktualny rok.

Sygnatura funkcji:

$.time.year(): string;

Funkcja month

Funkcja ta zwraca aktualny miesiąc.

Sygnatura funkcji:

$.time.month(): string;

Funkcja day

Funkcja ta zwraca aktualny dzień miesiąca.

Sygnatura funkcji:

$.time.day(): string;

Funkcja hour

Funkcja ta zwraca aktualną godzinę.

Sygnatura funkcji:

$.time.hour(): string;

Funkcja minute

Funkcja ta zwraca aktualną minutę.

Sygnatura funkcji:

$.time.minute(): string;

Funkcja second

Funkcja ta zwraca aktualną sekundę.

Sygnatura funkcji:

$.time.second(): string;

Funkcja nanosecond

Funkcja ta zwraca aktualną nanosekundę.

Sygnatura funkcji:

$.time.nanosecond(): string;

Moduł Crypto

Dostęp do modułu uzyskamy poprzez:

$.crypto: Object;

Moduł ten pozwala wykorzystanie popularnych algorytmów szyfrujących/haszujących.

Funkcja sha1

Funkcja ta tworzy hash sha1.

$.crypto.sha1(value: string): string;

Funkcja sha224

Funkcja ta tworzy hash sha2 - 224.

$.crypto.sha224(value: string): string;

Funkcja sha256

Funkcja ta tworzy hash sha2 - 256.

$.crypto.sha256(value: string): string;

Funkcja sha384

Funkcja ta tworzy hash sha2 - 384.

$.crypto.sha384(value: string): string;

Funkcja sha512

Funkcja ta tworzy hash sha2 - 512.

$.crypto.sha512(value: string): string;

Funkcja sha512_224

Funkcja ta tworzy hash sha2 - 512/224.

$.crypto.sha512_224(value: string): string;

Funkcja sha512_256

Funkcja ta tworzy hash sha2 - 512/256.

$.crypto.sha512_256(value: string): string;

Funkcja sha3_224

Funkcja ta tworzy hash sha3 - 224.

$.crypto.sha3_224(value: string): string;

Funkcja sha3_256

Funkcja ta tworzy hash sha3 - 256.

$.crypto.sha3_256(value: string): string;

Funkcja sha3_384

Funkcja ta tworzy hash sha3 - 384.

$.crypto.sha3_384(value: string): string;

Funkcja sha3_512

Funkcja ta tworzy hash sha3 - 512.

$.crypto.sha3_512(value: string): string;

Funkcja md4

Funkcja ta tworzy hash md4.

$.crypto.md4(value: string): string;

Funkcja md5

Funkcja ta tworzy hash md5.

$.crypto.md5(value: string): string;

Funkcja keccak256

Funkcja ta tworzy hash keccak256.

$.crypto.keccak256(value: string): string;

Funkcja keccak512

Funkcja ta tworzy hash keccak512.

$.crypto.keccak512(value: string): string;

Moduł Hash

Dostęp do modułu uzyskamy poprzez:

$.hash: Object;

Moduł ten pozwala wykorzystanie popularnych algorytmów haszujących.

Funkcja adler32

Funkcja ta tworzy hash adler32.

$.hash.adler32(value: string): string;

Funkcja fnv1_32

Funkcja ta tworzy hash fnv1_32.

$.hash.fnv1_32(value: string): string;

Funkcja fnv1a_32

Funkcja ta tworzy hash fnv1a_32.

$.hash.fnv1a_32(value: string): string;

Funkcja fnv1_64

Funkcja ta tworzy hash fnv1_64.

$.hash.fnv1_64(value: string): string;

Funkcja fnv1a_64

Funkcja ta tworzy hash fnv1a_64.

$.hash.fnv1a_64(value: string): string;

Funkcja fnv1_128

Funkcja ta tworzy hash fnv1_128.

$.hash.fnv1_128(value: string): string;

Funkcja fnv1a_128

Funkcja ta tworzy hash fnv1a_128.

$.hash.fnv1a_128(value: string): string;

Moduł Math

Dostęp do modułu uzyskamy poprzez:

$.math: Object;

Moduł ten udostępnia różne wartości i funkcje matematyczne.

Funkcja abs

Funkcja ta zwraca nam wartości absolutne od podanych wartości.

$.math.abs(value: number): number;
$.math.abs([...values: number[]]): number[];

Moduł Geolocation

Dostęp do modułu uzyskamy poprzez:

$.geolocation: Object;

Moduł ten udostępnia informacje na temat geolokacji.

Funkcja latitude

Funkcja ta zwraca szerokość geograficzną urządzenia na którym jest wykonywana.

$.geolocation.latitude(): Promise;
await $.geolocation.latitude(): number | PositionError;

Funkcja longitude

Funkcja ta zwraca długość geograficzną urządzenia na którym jest wykonywana.

$.geolocation.longitude(): Promise;
await $.geolocation.longitude(): number | PositionError;

Moduł secure

Dostęp do modułu uzyskamy poprzez:

$.secure: Object;

Moduł ten udostępnia funkcje które pozwolą lepiej zabezpieczyć twoją stronę internetową.

Funkcja secureLinks

Funkcja ta zabezpiecza wszystkie tagi A na stronie poprzez dodanie do atrybuty rel wartości: noopener, noreferrer.

$.secure.secureLinks(): void;

Funkcja redirectToHTTPS

Funkcja ta przekierowuje użytkownika na https wersję strony na której się znajduje.

$.secure.redirectToHTTPS(): boolean;