a collection of lightweight TypeScript packages for AT Protocol, the protocol powering Bluesky
atproto
bluesky
typescript
npm
docs: flesh out READMEs for bluesky packages
+13
-13
+8
-8
packages/bluesky/moderation/README.md
+8
-8
packages/bluesky/moderation/README.md
···
62
62
use different contexts depending on where content appears:
63
63
64
64
```ts
65
-
// in feeds/lists
65
+
// content in feeds/lists
66
66
getDisplayRestrictions(decision, DisplayContext.ContentList);
67
67
68
-
// viewing full post
68
+
// content in expanded view
69
69
getDisplayRestrictions(decision, DisplayContext.ContentView);
70
70
71
-
// media (images/videos)
72
-
getDisplayRestrictions(decision, DisplayContext.ProfileMedia);
71
+
// images/videos in content
72
+
getDisplayRestrictions(decision, DisplayContext.ContentMedia);
73
73
74
-
// profile lists
74
+
// profile in lists
75
75
getDisplayRestrictions(decision, DisplayContext.ProfileList);
76
76
77
-
// viewing full profile
77
+
// profile in expanded view
78
78
getDisplayRestrictions(decision, DisplayContext.ProfileView);
79
79
80
-
// profile name/avatar
81
-
getDisplayRestrictions(decision, DisplayContext.ProfileName);
80
+
// profile avatar/banner
81
+
getDisplayRestrictions(decision, DisplayContext.ProfileMedia);
82
82
```
83
83
84
84
### loading preferences
+1
-1
packages/bluesky/richtext-builder/lib/index.ts
+1
-1
packages/bluesky/richtext-builder/lib/index.ts
···
129
129
/**
130
130
* Add inline hashtag to the rich text
131
131
* @param tag The tag, without the pound prefix
132
-
* @returns THe builder instance, for chaining
132
+
* @returns The builder instance, for chaining
133
133
*/
134
134
addTag(tag: string): this {
135
135
return this.addDecoratedText('#' + tag, { $type: 'app.bsky.richtext.facet#tag', tag: tag });
+1
-1
packages/bluesky/richtext-parser/README.md
+1
-1
packages/bluesky/richtext-parser/README.md
···
216
216
| `link` | `url`, `children` | markdown link with nested tokens |
217
217
| `strong` | `children` | \*\*bold\*\* |
218
218
| `emphasis` | `children` | \_italic\_ |
219
-
| `underline` | `children` | \*\*underline\*\* |
219
+
| `underline` | `children` | \_\_underline\_\_ |
220
220
| `delete` | `children` | \~~strikethrough~~ |
221
221
| `code` | `content` | \`inline code` |
222
222
| `escape` | `escaped` | backslash escape |
+1
-1
packages/bluesky/richtext-segmenter/README.md
+1
-1
packages/bluesky/richtext-segmenter/README.md
+2
-2
packages/bluesky/search-parser/README.md
+2
-2
packages/bluesky/search-parser/README.md
···
10
10
highlighting operators or extracting filter values.
11
11
12
12
```ts
13
-
import { tokenize } from '@atcute/bluesky-search-parser';
13
+
import { tokenize, type Token } from '@atcute/bluesky-search-parser';
14
14
15
-
const tokens = tokenize(`from:me hello "foo bar"`);
15
+
const tokens: Token[] = tokenize(`from:me hello "foo bar"`);
16
16
// [
17
17
// { type: 'word', value: 'from:me' },
18
18
// { type: 'whitespace', value: ' ' },