Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

status of createSymlink and createSymlinkSync #758

Closed
davidjgoss opened this issue Feb 8, 2020 · 1 comment · Fixed by #766
Closed

status of createSymlink and createSymlinkSync #758

davidjgoss opened this issue Feb 8, 2020 · 1 comment · Fixed by #766
Labels
documentation
Milestone
9.0.0

Comments

@davidjgoss
Copy link

davidjgoss commented Feb 8, 2020 •
edited
Loading

These methods are exposed on the main export of fs-extra:

  • createSymlink
  • createSymlinkSync

But they aren't documented (and, I assume consequently, they aren't in the community-published typings).

Should these be added to the documentation? Or is the intent for users to just use ensureSymlink - and if so should these be omitted from the main export?
@davidjgoss davidjgoss mentioned this issue Feb 8, 2020
Merged
2 tasks
@RyanZim
Copy link
Collaborator

RyanZim commented Feb 8, 2020

Yeah, that's a mistake that they weren't documented. However, I'm considering removing the create* aliases in the next major release.

@RyanZim RyanZim added this to the 9.0.0 milestone Feb 8, 2020
peterblazejewicz added a commit to peterblazejewicz/DefinitelyTyped that referenced this issue Feb 15, 2020
@peterblazejewicz
fix(fs-extra): missing createSymlink
b1d624e 
Missed:
- `createSymlink`
- `createSymlinkSync`

see: jprichardson/node-fs-extra#758
see: cucumber/cucumber-js#1286

Thanks!
@peterblazejewicz peterblazejewicz mentioned this issue Feb 15, 2020
Merged
6 tasks
PranavSenthilnathan pushed a commit to DefinitelyTyped/DefinitelyTyped that referenced this issue Feb 18, 2020
@peterblazejewicz
fix(fs-extra): missing createSymlink (#42385)

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode
6ab9d89 
Missed:
- `createSymlink`
- `createSymlinkSync`

see: jprichardson/node-fs-extra#758
see: cucumber/cucumber-js#1286

Thanks!
RyanZim added a commit that referenced this issue Feb 24, 2020
@RyanZim
Document all create*() aliases for ensure*() methods
ba7a36f 
Fixes #758
@RyanZim RyanZim mentioned this issue Feb 24, 2020
Merged
RyanZim added a commit that referenced this issue Feb 26, 2020
@RyanZim
Document all create*() aliases for ensure*() methods (#766)

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode
223eb89 
Fixes #758
@change007chan change007chan mentioned this issue Mar 6, 2020
Closed
@dependabot dependabot bot mentioned this issue Mar 15, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
9.0.0
Development

Successfully merging a pull request may close this issue.

Document all create*() aliases for ensure*() methods jprichardson/node-fs-extra
2 participants
@davidjgoss @RyanZim