Normalizers: add jsdoc heading

next-old
Alex Gleason 2022-03-12 15:01:00 -06:00
rodzic 2089cb124d
commit b100068b95
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 7211D1F99744FBB7
5 zmienionych plików z 27 dodań i 1 usunięć

Wyświetl plik

@ -1,3 +1,8 @@
/**
* Account normalizer:
* Converts API accounts into our internal format.
* @see {@link https://docs.joinmastodon.org/entities/account/}
*/
import escapeTextContentForBrowser from 'escape-html';
import {
Map as ImmutableMap,

Wyświetl plik

@ -1,3 +1,8 @@
/**
* Emoji normalizer:
* Converts API emojis into our internal format.
* @see {@link https://docs.joinmastodon.org/entities/emoji/}
*/
import { Record as ImmutableRecord, Map as ImmutableMap } from 'immutable';
// https://docs.joinmastodon.org/entities/emoji/

Wyświetl plik

@ -1,3 +1,8 @@
/**
* Instance normalizer:
* Converts API instances into our internal format.
* @see {@link https://docs.joinmastodon.org/entities/instance/}
*/
import {
Map as ImmutableMap,
List as ImmutableList,
@ -9,6 +14,7 @@ import { mergeDefined } from 'soapbox/utils/normalizers';
import { isNumber } from 'soapbox/utils/numbers';
// Use Mastodon defaults
// https://docs.joinmastodon.org/entities/instance/
const InstanceRecord = ImmutableRecord({
approval_required: false,
contact_account: ImmutableMap(),

Wyświetl plik

@ -1,3 +1,8 @@
/**
* Notification normalizer:
* Converts API notifications into our internal format.
* @see {@link https://docs.joinmastodon.org/entities/notification/}
*/
import {
Map as ImmutableMap,
Record as ImmutableRecord,

Wyświetl plik

@ -1,3 +1,8 @@
/**
* Status normalizer:
* Converts API statuses into our internal format.
* @see {@link https://docs.joinmastodon.org/entities/status/}
*/
import escapeTextContentForBrowser from 'escape-html';
import {
Map as ImmutableMap,
@ -11,6 +16,7 @@ import { normalizeEmoji } from 'soapbox/normalizers/emoji';
import { IStatus } from 'soapbox/types';
import { mergeDefined, makeEmojiMap } from 'soapbox/utils/normalizers';
// https://docs.joinmastodon.org/entities/status/
const StatusRecord = ImmutableRecord({
account: null,
application: null,
@ -99,7 +105,6 @@ const PollOptionRecord = ImmutableRecord({
});
// Ensure attachments have required fields
// https://docs.joinmastodon.org/entities/attachment/
const normalizeAttachment = (attachment: ImmutableMap<string, any>) => {
const url = [
attachment.get('url'),