@xylabs/pixel
Advanced tools
Event Client for xylabs ESB
@xylabs/pixel
new PixelApi(baseUri): PixelApi;
string = 'prod'
PixelApi
trackEvents(events): Promise<any>;
Promise<any>
new Referrer(): Referrer;
Referrer
local: string;
session: string;
toJson():
| undefined
| {
local: string;
session: string;
};
| undefined
| {
local: string;
session: string;
}
new UniqueUserId(): UniqueUserId;
UniqueUserId
id: string;
toString(): string;
string
TData extends EmptyObject
new UserEventHandler<TData>(): UserEventHandler<TData>;
UserEventHandler<TData>
abstract funnelStarted<T>(fields): Promisable<void>;
T extends object
Promisable<void>
abstract testStarted<T>(fields): Promisable<void>;
T extends object
Promisable<void>
abstract userClick<T>(fields): Promisable<void>;
T extends object
UserClickFields | T
Promisable<void>
abstract viewContent<T>(fields): Promisable<void>;
T extends object
Promisable<void>
new UtmFields(): UtmFields;
UtmFields
fields: Record<string, string>[] = [];
getUtmRecord(): null | Record<string, string>;
null | Record<string, string>
toString(): string;
string
update(): Record<string, string>[];
Record<string, string>[]
static api: PixelApi;
cid: string;
optional email: string;
optional email_hash: null | string;
optional exids: ExIds;
optional pixelId: string;
queue: UserEvent[] = [];
get static instance(): XyPixel;
XyPixel
static init(pixelId): XyPixel;
string
XyPixel
static selectApi(api): void;
void
identify(email?): void;
string
void
send<T>(
event,
fields?,
eventId?): Promise<void>;
T extends JsonObject
string
T
string
Promise<void>
T extends EmptyObject = EmptyObject
new XyUserEventHandler<T>(): XyUserEventHandler<T>;
XyUserEventHandler<T>
funnelStarted(fields): Promise<void>;
Promise<void>
UserEventHandler.funnelStarted
purchase(fields): Promise<void>;
PurchaseFields | T
Promise<void>
testStarted(fields): Promise<void>;
Promise<void>
userClick(fields): Promise<void>;
UserClickFields | T
Promise<void>
viewContent(fields): Promise<void>;
Promise<void>
optional funnel: string;
optional testData: string;
optional funnel: string;
optional testData: string;
name: string;
optional funnel: string;
optional testData: string;
id: string;
optional name: string;
optional price: number;
optional value: number;
optional funnel: string;
optional testData: string;
name: string;
optional funnel: string;
optional testData: string;
elementName: string;
elementType: string;
optional intent: string;
optional placement: string;
cid: string;
optional create_time: number;
optional email: string;
optional email_hash: string;
optional event: string;
optional event_id: string;
optional exids: ExIds;
optional fields: Record<string, unknown>;
optional host: string;
optional pathname: string;
optional pixel: string;
optional receive_time: number;
optional referrer: object;
local: string;
session: string;
optional rid: string;
optional system: ParsedResult;
optional uid: string;
optional utm: Record<string, string>[] | Record<string, string[]>;
optional funnel: string;
optional testData: string;
name: string;
path: string;
cid: string;
optional create_time: number;
optional email: string;
optional email_hash: string;
optional event: string;
optional event_id: string;
optional exids: Record<string, string>;
optional fields: Record<string, unknown>;
optional host: string;
optional ip: string;
optional pathname: string;
optional pixel: string;
optional receive_time: number;
optional rid: string;
optional system: unknown;
optional ua: string;
optional uid: string;
optional utm: Record<string, string>[] | Record<string, string[]>;
type UserEventSystem = Bowser.Parser.ParsedResult;
Part of sdk-js
See the LICENSE file for license details
FAQs
Event Client for xylabs ESB
We found that @xylabs/pixel demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Following multiple malicious extension incidents, Open VSX outlines new safeguards designed to catch risky uploads earlier.
Research
/Security News
Threat actors compromised four oorzc Open VSX extensions with more than 22,000 downloads, pushing malicious versions that install a staged loader, evade Russian-locale systems, pull C2 from Solana memos, and steal macOS credentials and wallets.
Security News
Lodash 4.17.23 marks a security reset, with maintainers rebuilding governance and infrastructure to support long-term, sustainable maintenance.